DelphiCodeToDoc - Inlines syntax

Inlines Syntax

In this page, I will explain how to write Inlines comments for DelphiCodeToDoc in the Delphi environment. You should read this document before : how to write JavaDoc comments

Format of an inline Comment
An inline doc comment is a short way to describe a class, field, constructor or method declaration. It should be used very very rarely, and only when you think there is no need to detail more.

Example

/// Main Class that manage the Parser, the Structure Builder and the Generator
TDOCProject = class
private
  FDocOptions : TDOCOptions;    /// project's Options shared with Generator
  FDocStructure: TDOCStructure; /// Holds the skeleton of the source code
  FFileList: TStringList;       /// List of all file that will be processed
  FState : TProjectState;       /// State of the project (New, Checked of Built)
  FisChecked: boolean;          /// Specified if project has already been checked
  FdmUserMessages: TStrings;    /// Reference for writting User messages
  FdmDebugMessages: TStrings;   /// Reference for writting Debug messages
...

Simple Inline
Writting a comment line with double slash ( // ) - or triple slash ( /// ) if define in configuration panel - before a class, field or method will be processed as a Description TAG.

End of line Inline
Writting a comment line at the end of a line with double slash ( // ) - or triple slash ( /// ) if define in configuration panel - before a field (and only a Field) will be processed as a Description TAG for the preceding Field.