锐客网

  1. 首页 > 睿知 > it技术 > >

c语言输出函数注释 c语言的输出函数分别有哪几种( 三 )

IT技术代码


应如下书写
/* code one comments */
program code one
/* code two comments */
program code two
14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释 。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档 。
15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释 。
说明：这样比较清楚程序编写者的意图 ， 有效防止无故遗漏break语句 。
示例（注意斜体加粗部分）：
case CMD_UP:
ProcessUp();
break;
case CMD_DOWN:
ProcessDown();
break;
case CMD_FWD:
ProcessFwd();
if (...)
{
...
break;
}
else
{
ProcessCFW_B();// now jump into case CMD_A
}
case CMD_A:
ProcessA();
break;
case CMD_B:
ProcessB();
break;
case CMD_C:
ProcessC();
break;
case CMD_D:
ProcessD();
break;
...
建议:
1：避免在一行代码或表达式的中间插入注释 。
说明：除非必要，不应在代码或表达中间插入注释 ， 否则容易使代码可理解性变差 。
2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的 。
说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释 。
3：在代码的功能、意图层次上进行注释，提供有用、额外的信息 。
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息 。
示例：如下注释意义不大 。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息 。
/* if mtp receive a message from links */
if (receive_flag)
4：在程序块的结束行右方加注释标记，以表明某程序块的结束 。
说明：当代码段较长 ， 特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读 。
示例：参见如下例子 。
if (...)
{
// program code
while (indexMAX_INDEX)
{
// program code
} /* end of while (indexMAX_INDEX) */ // 指明该条while语句结束
} /* end ofif (...)*/ // 指明是哪条if语句结束
5：注释格式尽量统一，建议使用"/* …… */" 。
6：注释应考虑程序易读及外观排版的因素 ， 使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达 。
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑 ， 建议使用中文 。
C语言中如何注释？一般来讲有两种：
一是单行注释：直接在该行需要注释的地方加上"//"就行了 。例如：
"int a,b;//这是一个注释行" 。那么，"//"后面的部分"这是一个注释行"就被注释掉了，不起作用 ， 但是"//"前面的“int a,b;"不受影响 。
另外还有一种是多行同时注释：
/*
int a,b;
int c,d;
*/
其中"/*"和"*/"起限定范围的作用，该范围内的语句都会被注释掉，将不再起作用 。当然，多行注释也是可以用来单行注释的
c语言如何注释？直接在该行需要注释的地方加上"//"即可 。
可以使用/*和*/分隔符来标注一行内的注释，也可以标注多行的注释 。例如，在下列的函数原型中，省略号的意思是 open() 函数有第三个参数 ， 它是可选参数 。

推荐阅读


上一篇：伊春专注sap软件运维，伊春专注sap软件运维公司

下一篇：网红消防直播，消防直播回放完整版