|
| |
|
|
| |
| 1.1 注释问题 |
a)样例代码如下：
appQueueInit(); //init queue
appCreateTask(); //create task
appThreadMain(); |
 |
评述如下：
(1)注释格式没对齐，第1，2行的注释格式需要整齐
(2)注释信息要完整，第3行的注释同样需要
(3)注释描述要充分，在函数调用的时候需要对该函数实现的功能进行描述，避免代码走读时需要进入函数才能了解其功能
b)样例代码如下： |
|
评述如下：
(1)对于一个独立的功能块，必须加上注释
(2)特别是，For，If，While等语句前都应该加注释 |
原则：
写注释是为了让别人能看懂你写的程序。在以下一些代码中必须写注释：
√函数的开头（说明该函数的功能，参数，返回值，版本等）
√一个独立逻辑的开头（比如一个FOR程序）
√逻辑判断的开头（比如IF语句）
√调用函数的开头（比如strcmp函数）
√出错信息的开头（比如RETURN XXXERR）
养成习惯：
每次在写注释时，想一想自己写的注释是否其他人能看懂，信息量是否足够。 |
|
|
|
