文件头阐明 :源程序(如头文件.h文件、.inc文件、.def文件、编译阐明文件.cfg等)头部应进行注释,注释有必要列出:版权阐明、版别号、生成日期、作者、内容、功用、与其它文件的联系、修正日志等,头文件的注释中还应有函数功用扼要阐明。
/************************************************************
版权信息:
文件名: test.cpp
作者: 日期:
功用:
版别:
前史修正记载
<作者> <日期> <版别 > <阐明>
***********************************************************/
常量、编译宏命名
阐明:常量、编译宏悉数大写,单词间运用下划线分隔。
关于变量命名,制止取单个字符(如i、j、k…),主张除了要有详细意义外,还能标明其变量类型、数据类型等,但i、j、k作部分循环变量是答应的。阐明:变量,尤其是部分变量,假如用单个字符表明,很简单敲错(如i写成j),而编译时又查看不出来,有或许为了这个小小的过错而花费很多的查错时刻。
示例:下面所示的部分变量名的界说办法能够学习。
int liv_Width
其变量名解说如下:
l部分变量(Local)(其它:g全局变量(Global)…)
i数据类型(Interger)
boolean b
char c
long l
float f
double d
int i
unsigned int ui
指针 p
结构 s
输入管脚 bi
输出管脚 bo
v变量(Variable)(其它:c常量(Const)…)
Width变量意义