First Word Example

You are here: More Information

Special Tasks

Technical Reference

FAQ

Getting Technical Support

> Comment Handling

File and Parsing Options

Comment Finding

Adjusting Doc-O-Matic

Comment Handling

Documenting without Editor

> Parameter and Return Value Descriptions

Empty Topics

Ignoring Lines

Parameter and Return Value Descriptions

Ignored and Removed Characters

Doc-O-Matic 10

First Word Example

Parameter and Return Value Descriptions

Delphi/Pascal style
    i: Integer - This is the description of i
VB.NET style
    i As Integer - This is the description of i

Using the First Word or the Last Word option, the parameter name part must not contain the parameter delimiter character. If a description of a parameter exceeds one line and is continued on new lines these new lines must not contain the delimiter character either.