Created on Jan. 1, 2013, 5:44 p.m. by Hevok & updated by Hevok on May 22, 2013, 8:11 p.m.

A comment is remark, like an added piece of information, or an observation or statement. Comments are therefore used to annotate data.

Denigma' commenting system makes it possible to attach a Comment to any arbitrary database object/record. The name can be either the name of the user or alternatively used as title of the posted Comment Data Unit. Optionally an Email address can be defined that enables to be notified by follow-up Comments (the address is treated confidentially and will not be exposed). An URL may also be specified which can point to the website of the user or to a site which the Comment is referring to. The Comment itself is rendered via Markdown (Markdown vs. reStructuredText) and hyper- as well as crosslinks are generated automatically. Authenticated user have the additional possibility to change their comments post posted. Both Email and Name fields are only optional for authenticated users.

In Programming Comments shall be used extensively to add explanatory information embedded in the source code. There Comments are not interpreted but used to document code.


Tags: remarks, annotations, documentation
Categories: News
Parent: Denigma

Update entry (Admin) | See changes

1 Comment to Comment

Daniel Wuttke (Hevok)  on May 22, 2013, 8:10 p.m.


permalink for comment 1