锐客网

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

c语言函数描述注释怎么写 c语言注释的两种方法( 三 )

IT技术代码


示例（注意斜体加粗部分）：
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语言中注释的位置1、可以使用/*和*/分隔符来标注一行内的注释，也可以标注多行的注释 。例如，在下列的函数原型中，省略号的意思是 open() 函数有第三个参数，它是可选参数 。注释解释了这个可选参数的用法：
int open( const char *name, int mode, … /* int permissions */ );
2、可以使用//插入整行的注释，或者将源代码写成两列分栏的格式，程序在左列，注释在右列：
const double pi = 3.1415926536;// pi是—个常量
扩展资料
在 C99 标准中，单行注释正式加入C语言，但是大部分编译器在 C99 之前就已经开始支持这种用法 。有时候，其被称作“C++风格”的注释，但实际上，其源自于C的前身 BCPL 。
1、在引号中，如果采用/*或//分隔一个字符常量或字符串字面量（string literal），它们都不会被视为注释的开始 。例如，下面语句就没有注释：
printf("Comments in C begin with /* or //.\n" );
2、预处理器仅通过检查注释的结束符来检测注释中的字符，因此，不能嵌套块注释 。然而，可以使用/*和*/注释包含单行注释的源代码：
/* 暂时注释掉这两行：
const double pi = 3.1415926536;// pi是一个常量
area = pi * r * r;// 计算面积
暂时注释到此 */
C语言中如何注释？一般来讲有两种：
一是单行注释：直接在该行需要注释的地方加上"//"就行了 。例如：
"int a,b;//这是一个注释行" 。那么，"//"后面的部分"这是一个注释行"就被注释掉了，不起作用，但是"//"前面的“int a,b;"不受影响 。

推荐阅读


上一篇：360休闲棋牌游戏的简单介绍

下一篇：为什么电脑word用不了，为什么我的电脑word不能用