Resources  
  FAQ
Online Help File
Examples
External Links
 
  Online Help File  
  The Time2HELP help file is available online.  
  Order Time2HELP  
  Order Time2help and pay by credit card, check or bank transfer.  
  Order online from Kagi.  
  Download trial version  
 

Download the 30 day trial version of Time2HELP now.

 
 

 

From Vision to Code - Built by Delphi

 

 
Painless Documentation
for your Source Code
 
    Home   Features  Download   Support   News   Order   

The @Param tag

Syntax

@param name description

Synonyms

None.

Description

This tag adds the specified parameter and its specified description to the "parameters" section for a method/routine.

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;
This page was last updated 2005-08-21 .
Copyright © 1997-2005 by Digital Logikk AS.