Add and edit source comments in your Delphi code - the easy way
Ingvarius DelphiComments will scan one or more PAS files and find classes and their respective
properties, methods and comments. These entities are
stored in several datasets, and if desired, may be saved to disk files. .
The main purpose of this application is to provide a user interface where one can
edit the source comments, without opening the source code file in the Delphi IDE.
It allows for a much cleaner and even faster way of editing source code
comments. As an additional bonus, the source documentation can be output to a Word
document.
DelphiComments is a gift to the Delphi community - totally free!
The application is fully capable of both forward and reverse engineering of commented source code.
QuickStart
Take a tour with the QuickStart tutorial!
Download
Download DelphiComments, it is totally free!
Forums
Visit the DelphiComments own user forum!
Newsletter
Sign up for the DelphiComments newsletter!
Comments style and standards
We have chosen to use the triple slash /// style
of commenting, by applying a /// in front of every commented line.
This is not as readable as one could wish, on the other hand it is some sort of
a standard, and other tools then easily will be able to extract the comments. Doc-O-Matic, for example.
We use DelhiComments extensively to save time, it is much faster
than editing the source code directly. We can then have
Doc-O-Matic scan the source code and output documentation automatically,
ready with comments.
DelphiComments is a prototype
This application is a full-blown working prototype which fulfills
common needs for commenting Delphi source code. It is not, however, a commercial
product. It is unfinished in the meaning it will
not be commercialized.
However, it is finished in the meaning it fulfills common needs for commenting Delphi
source code, in this meaning it is a full-blown application.
Being a prototype, no formal support is given and no responsibility is
taken for any side effects it may cause. We encourage you though to use the available
support for this product, our user forums, newsletter and FAQ pages.
Release information
This product has already been released as a prototype give-away.
The current version is 0.9.0.54.
Feedback and comments are always welcome, visit our
support pages!
Product future
DelphiComments will probably not be developed further. No further
releases are scheduled. On the other hand, since the application is in use, some
small enhancements
may take place, bugs
might be fixed. It is
not unlikely that small patches and bug fixes will be issued.
Sign up for our
newsletter
and be notified of updates!