14 lines
693 B
Markdown
14 lines
693 B
Markdown
## 3.3 Documentation Comments
|
|
|
|
AVAP™ also supports documentation comments, which are used to automatically generate documentation from the source code. These comments begin with `///` and are used to describe the functionality of classes, methods, variables, and other elements of the source code.
|
|
|
|
```javascript
|
|
/// This function adds two integers and returns the result.
|
|
/// \param a The first integer.
|
|
/// \param b The second integer.
|
|
/// \return The sum of the two numbers.
|
|
int sum(int a, int b) return a + b;
|
|
```
|
|
|
|
Documentation comments are essential for maintaining up-to-date and detailed documentation of the code, which facilitates its understanding and use by other developers.
|