TagsParametersWithoutParenthesis

Michalis Kamburelis edited this page Jan 8, 2017 · 5 revisions

You can also specify tag parameters without enclosing them in parenthesis. So you can write

{ @param S is the text to print
  @raises EMyException sometimes }
procedure Print(const S: string);

and it is equivalent to

{ @param(S is the text to print)
  @raises(EMyException sometimes) }
procedure Print(const S: string);

Parsing logic is simple: If a tag requires some parameters but you do not put an opening parenthesis '(' char right after it, then the tag’s parameters are supposed to span to the end of line (or to the end of comment). Note that this rule does not "break" the behavior of parameter-less tags like @name tag. Also it does not break comments that enclose tag parameters in parenthesis.

For more comments and examples of use you can take a look at test unit for this feature and pasdoc’s output for this test unit.

Advantages of not enclosing tag parameters in parenthesis are

  • sometimes this tends to look better in unit source

  • compatibility with JavaDoc and others

PasDoc, documentation generator for Pascal:
Features:
Supported Tags:
Command Line:
Development:
Developers pages:
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.