Unit ok_tag_params_no_parens

Description

This is a demo unit using tags without enclosing them in ()

Parsing logic is simple: if a tag requires some parameters but you don't put open paren '(' char right after it, then tag parameters are understood to span to the end of line (or to the end of comment).

This doesn't break compatibility with documentation that enclosed parameters in (), because tags that have parameters were *required* to have '(' char after them. So they will still be correctly seen and parsed to the matching closing paren.

You can even have multiline params without parens with the help of "line feed" char \ (just like shell scripts, C lang etc.)

See SomeProc for more examples and comments.

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EFoo  

Functions and Procedures

function SomeProc(A: Integer): Integer;

Description

Functions and Procedures

function SomeProc(A: Integer): Integer;

Note that this rule allows you to not specify () for *any* tag that has parameters. Even for @link tag: ok_tag_params_no_parens

This rule doesn't create any problems for tags without parameters, like the @name tag: here it is: SomeProc. Such tags never have parameters, and on the above line you *don't* have @name tag with parameters "tag. Such tags never have parameters,". Instead, you just specified SomeProc tag and "tag. Such tags never have parameters," is just a normal text.

Check out this longcode:

begin Writeln('Hello world'); end; { This works ! }

See also @html and @latex tags: I'm red

And here is some code: begin X := Y + 1; end;

Parameters
A
means something or maybe nothing
Returns

Some integer and good wishes

Exceptions raised
EBar
when it's in bad mood. But don't worry it won't happen too often. At least we hope so...

Authors

Created

2005-05-04

Last Modified

2005-05-04