diff --git a/tutorial/code-style.md b/tutorial/code-style.md index a4dd2866a406532e15977344f3b788d92288bd93..d3203be01ae2ed8c8d06883bb284ec0e598dc2a5 100644 --- a/tutorial/code-style.md +++ b/tutorial/code-style.md @@ -147,6 +147,21 @@ typedef enum SoundType SoundType; bufSize = 16; // set buffer Size ``` +注意,因为[新增了Doxygen](https://gitee.com/BookOS/nxos/issues/I5JSGE),所以需要在每个函数前加上如下的格式: + +```c +/** + * @brief Set Color at (x,y) + * @param x: x number + * @param y: y number + * @retval 0 Done + * @retval -1 Error + */ +int NX_SetColorAt(int x, int y) { + ... +} +``` + ## 11.缩进以及分行 缩进请采用 4 个空格的方式。如果没有什么特殊意义,请在 "{" 后进行分行,并在下一行都采用缩进的方式,例如: