DelphiCodeToDoc - JavaDoc TAG @comment

JavaDoc TAG @comment

There is two way to work with this new TAG : in a block comment with the @comment TAG, or with the Inline Extended comment inside a method or function.

@comment text
Adds an "additional comment" subheading with the specified text to the generated documentation. Use this TAG to add other information to the Unit, class, method or function.

{*------------------------------------------------------------------------------
Handle BDF Files

  BDFfont is a library to handle BDF font (Bitmap Distribution Format file)
  font with Delphi.
  This library will solve the lack of support for bitmap font on MS-Windows.
  A complete documentation and few examples are also available.
  Get last revision at : http://sourceforge.net/projects/bdffont/
  Copyright TridenT 2003 - Under GNU GPL licence

@Author TridenT
@Comment Handle exception from a file access error
-------------------------------------------------------------------------------}
unit u_BDFfont;
...

*Inline Extended comment
Adds an "additional comment" subheading with the specified text to the generated documentation. Use the Inline TAG as Description TAG but inside a method or function. The default syntex is Double Slash + the JavaDoc Prefix for Inline.
This syntax is usefull to add algorithm of method in the code and in the documentation.

{*---------------------
  Test ClassProcedure !
----------------------}
procedure TNewClass.ClassProc;
begin
  /// This is a extended description
  if ((Attr and FileInfo.Attr) <> 0) and SameText(ExtractFileExt(FileInfo.Name)
   ,PAS_FILE_EXT) then
  /// And another description
  Inc(i);
end;