c语言程序注释模板.docx
《c语言程序注释模板.docx》由会员分享，可在线阅读，更多相关《c语言程序注释模板.docx（8页珍藏版）》请在冰点文库上搜索。
c语言程序注释模板
竭诚为您提供优质文档/双击可除
c语言程序注释模板
篇一：
c语言编写规范之注释
1、头文件包含includes
2、私有类型定义privatetypedef
3、私有定义privatedefine
4、私有宏定义privatemacro
5、私有变量privatevariables
6、私有函数原型privatefunctionprototypes
7、私有函数privatefunctions
8、私有函数前注释
/*******************************************************************************
*Functionname:
Fsmc_noR_init
*description:
conf
igurestheFsmcandgpiostointerfacewiththenoRmemory.*thisfunctionmustbecalledbeforeanywrite/readoperation
*onthenoR.
*input:
none
*output:
none
*Return:
none
*******************************************************************************/
9、程序块采用缩进风格编写，缩进空格为4。
10、相对独立的程序块之间、变量说明之后必须加空行；
11、较长的字符（>80字符）要分成多行书写，长表达式要在低优先级操作符划分新行，操作符放在新行之首，新行要恰当缩进，保持排版整齐；
12、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首;
13、若函数或过程中的参数较长，则要进行适当的划分。
14、不允许把多个短语句写在一行中，即一行只写一条语句。
15、if、for、do、while、case、switch、default等语句自占一行，且if、for、
do、while等语句的执行语句部分无论多少都要加括号{}。
16、对齐只使用空格键，不使用tab键；
17、
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求
18、
程序块的分界符（如c/c++语言的大括号{和}）应各独占一行并且位于同一
列，同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以
及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
19、
在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或
者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格；
20、一行程序以小于80字符为宜，不要写得过长。
21、一般情况下，源程序有效注释量必须在20％以上。
注释不宜太多、不宜太少，准确易懂简洁；
22、
说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应
进行注释，注释必须列出：
版权说明、版本号、生成日期、作者、内容、功能、与其它文件的
关系、修改日志等，头文件的注释中还应有函数功能简要说明。
23、
源文件头部应进行注释，列出：
版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
如：
24、
函数头部应进行注释，列出：
函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
25、
边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
不再有
用的注释要删除
26、
注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：
错误的注释不但无益反而有害；
27、
避免在注释中使用缩写，特别是非常用缩写；
28、
注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
29、
数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，必须
加以注释。
对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注
释放在此域的右方；
30、
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
31、
注释与所描述内容进行同样的缩排
32、将注释与其上面的代码用空行隔开；
33、对变量的定义和分支语句（条件分支、循环语句等）必须编写注释；
34、
对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释；35、
通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构；
在代码的功能、意图层次上进行注释，提供有用、额外的信息。
36、
在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：
当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
37、
注释格式尽量统一，建议使用“/*……*/”
38、
注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达；
篇二：
俄罗斯方块c语言程序带注释
篇三：
c语言格式书写规范
c语言书写规范指南
第1章文件结构
每个c程序通常分为两个文件。
一个文件用于保存程序的声明（declaration），称为头文件。
另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。
c程序的头文件以“.h”为后缀，c程序的定义文件以“.c”为后缀。
1.1版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：
（1）版权信息。
（2）文件名称，标识符，摘要。
（3）当前版本号，作者/修改者，完成日期。
（4）版本历史信息。
/*
*copyright（c）20xx,吉林大学物理学院无线电
*allrightsreserved.
*
*文件名称：
filename.h
*文件标识：
*摘要：
简要描述本文件的内容
*
*当前版本：
1.1
*作者：
输入作者（或修改者）名字
*完成日期：
20xx年7月20日
*
*取代版本：
1.0
*原作者：
输入原作者（或修改者）名字
*完成日期：
20xx年5月10日
*/
示例1-1版权和版本的声明
1.2头文件的结构
头文件由三部分内容组成：
（1）头文件开头处的版权和版本声明（参见示例1-1）。
（2）预处理块。
（3）函数和类结构声明等。
假设头文件名称为scl_spi.h，头文件的结构参见示例1-2。
【规则1-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。
【规则1-2-2】用#include格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。
【规则1-2-3】用#include“filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
【规则1-2-4】#include后面使用tab键控制排版。
【规则1-2-5】头文件中只存放“声明”而不存放“定义”
【规则1-2-6】全局变量在头文件中声明,在.c文件中定义
.hexternintvalue;声明。
.cintvalue=0x10;定义。
【规则1-2-7】局部变量在.c中定义（static）unsignedintvalue;定义。
//版权和版本声明见示例1-1，此处省略。
#ifndef
#define
#include
scl_spi_h//防止scl_spi.h被重复引用scl_spi_h //引用标准库的头文件
“scl_can.h”//引用非标准库的头文件#include
voidFunction1（）;//全局函数声明
externunsignintvalue;//全局变量声明
#endif
示例1-2c头文件的结构
1.3定义文件的结构
定义文件有三部分内容：
（1）定义文件开头处的版权和版本声明（参见示例1-1）。
（2）对一些头文件的引用。
（3）程序的实现体（包括数据和代码）。
假设定义文件的名称为scl_spi.c，定义文件的结构参见示例1-3。
//版权和版本声明见示例1-1，此处省略。
#include“scl_spi.h”//引用头文件
//全局变量定义
unsignintvalue=0x10;
//全局函数的实现体
voidFunction1（）
{
}
示例1-3c定义文件的结构
1.4头文件的作用
早期的编程语言如basic、Fortran没有头文件的概念，c语言的初学者虽然会用使用头文件，但常常不明其理。
这里对头文件的作用略作解释：
（1）通过头文件来调用库功能。
在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。
用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。
编译器会从库中提取相应的代码。
（2）头文件能加强类型安全检查。
如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。
1.5目录结构
如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。
例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。
如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。
为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。
第2章程序的版式
版式虽然不会影响程序的功能，但会影响可读性。
程序的版式追求清晰、美观，是程序风格的重要构成因素。
可以把程序的版式比喻为“书法”。
好的“书法”可让人对程序一目了然，看得兴致勃勃。
差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。
请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。
2.1空行
空行起着分隔程序段落的作用。
空行得体（不过多也不过少）将使程序的布局更加清晰。
空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。
所以不要舍不得用空行。
【规则2-1-1】在每个函数定义结束之后都要加空行。
参见示例2-1（a）
【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。
参见示例2-1（b）
//空行
voidFunction1（）
{
}
//空行
voidFunction2（）
{
}
示例2-1（a）函数之间的空行
//空行
while（condition）
{
statement1;
//空行
if（condition）
{
statement2;
}
else
{
statement3;
}
//空行
statement4;
}
示例2-1（b）函数内部的空行
2.2代码行
【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。
这样的代码容易阅读，并且方便于写注释。
【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
这样可以防止书写失误。
示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。
【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则）
如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。
如果引用了未被初始化的变量，可能会导致程序错误。
本建议可以减少隐患。
例如
intwidth=10;//定义并初绐化width
intheight=10;//定义并初绐化height
intdepth=10;//定义并初绐化depth
使用tab键控制距离
升级会员 