村居高鼎,爱物秀场,小梓药
注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必须在20%以上。
注释的原则是有助于对程序的阅读理解,所以注释语言必须准确、易懂、简洁,注释不宜太多也不能太少,注释的内容要清楚、明了、含义准确,防止注释二义性,该加的地方一定要加,但不必要的地方一定不要加。
注释风格很多,这里只是对于我的代码进行规范。
filename
文件名description
模块描述change logs
变更日志/* * copyright (c), 1988-1999, xxxxxx tech. co., ltd. * filename: xxx * description: balabalabalabalabalabalabalabalabala balabalabalabalabalabalabalabalabalabalabalabala * change logs: |date |author |notes |version |2010-03-22 |xxx |xxx |1.0.0 */
function
函数名称description
函数描述calls
调用的函数清单input
输入参数说明,包括每个参数的作用、取值说明及参数间关系output
输出参数的说明return
函数返回值的说明others
其他说明/* * function: * description: * calls: * input: * input: * output: * return: * others: */
@define
定义块概述no error
定义值说明/* @define xxx */ #define xxx_error_ok 0 /* no error */ #define xxx_error_invalid_token 1 /* invalid token */ #define xxx_error_expect_type 2 /* expect a type */
@struct
结构体概述next item
结构体元素说明/* @struct xxx */ struct xxx_syscall_item { struct xxx_syscall_item* next; /* next item */ struct xxx_syscall syscall; /* syscall */ };
全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
description
作用描述scope
作用域range
取值范围notice
注意事项others
其他说明/* * description: * scope: * range: * notice: * others: */
如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复
如何在没有core文件的情况下用dmesg+addr2line定位段错误
用QT制作3D点云显示器——QtDataVisualization
网友评论