Function documentation
You can embed the documentation of a function into BI# programs:
int Add(int a, int b) @Description: "Adds two numbers."; @Parameter[a]: "First number to be added."; @Parameter[b]: "Second number to be added."; @Returns: "The sum of a and b."; @Category: "Math"; { return a + b; }
All documentation statements accept a description text that is encoded
as a
string
literal. The meaning of the
documentation statements is as follows:
Statements | Description |
---|---|
@Description
|
Description of the function's purpose. |
@Parameter[name]
|
Description of the parameter named
name .
|
@Returns
|
Description of the function's return value. |
@Category
|
In BI# all functions belong to a category.
For example, the
Sin() function belongs to the
'Mathematical' category.
|
The content of all documentation tags is part of the function's definition and will be displayed in the editor's auto-completion mechanism, for example.