Function comments (v1)
This commit is contained in:
@@ -71,12 +71,16 @@ Function prototypes should include parameter names and their data types.
|
||||
|
||||
## Commenting
|
||||
|
||||
Comments should describe what a function does and why, not how it does it.
|
||||
Comments should describe what a function does and why, not how it does it. The preferred way of commenting functions is the following:
|
||||
|
||||
```c
|
||||
/*
|
||||
* This is the preferred style for multi-line
|
||||
* comments in the Pepper kernel
|
||||
* function_name - Function brief description
|
||||
* @arg1: Argument 1 description
|
||||
* @arg2: Argument 2 description
|
||||
*
|
||||
* A longer description can be featured here, explaining more
|
||||
* in detail what the function does and why it does it.
|
||||
*/
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user