The @Param tag

Syntax

Synonyms

Description

Note that Time2HELP currently doesn't verify that the @param's you have documented actually are parameters of the current routine/method, nor whether you have documented them all. When you use the @param tag, you should document all the parameters, and in the sequence you would like them listed in the "parameters" section (typically the same as in the routine/method's declaration).

Example

{:Returns filedate of the file.
@param i_strFilename The file to get the file date from.}
Function FileDate(const i_strFilename: String): TDateTime;
Begin
...
End;