有两种注释方法:
// 行注释,可以注释其后的一行。
/* */ 块注释,注释这两个符号中间的所有区域。
【释的原则】
注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例:如下注释态橡或意义不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
【说明性文件头部应进行注释】
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【源文件头部应进行注释】
源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【函数头部应进行注释】
函数头部应进行注释,列出:函数的目的/ 功能、输入参数、输帆伍出参数、返回值、调用关系(函数、表)等。
示例1:下面这段函数的注释比较标准,当然,并不局限于此格式如陵,但上述信息建议要包含在内。
单行注释和成对注释。单行注释以双斜线(//)开头。同一行中斜线右侧的所有内容都是注释,会被编译器略过。另一个分隔符是注释符号对(/* */),它继承自C语言。这种注释以/*开始,以*/樱樱结尾。编译器把/*和*/之间的部分都作为注释来处理
注释符号对可以放置在允许输入tab、空格或新行的任何地方。注释符号对可以跨越程序的多个行,但是不是必须这样做的。当注释符号对没有跨越多个行,通常表明内部行是多行注释的一部分。我们的样式是每行以星号开始,因此表明整个范围都是多樱颂尺行注释的部分。
典型情况下程序包含多种注释形式。注释符号对通常用做多行解释,而双斜线注释倾向于半行或单行注释。
程序中混合了太多的注释可能使代码混乱。通常在要解释的代码上方放置注释。
随着代码的改变,注释也应该保持更新。程序员希望注释是精确的,并且很相信它们,即使其它形式的系统文档过期了。不正确的注释比没有注释还有糟糕,因为它会误导随后的阅读者。
注释符号对不能嵌套
以/*开始的注释通常以*/结束。其结果是一个注释符号对不能出现在另一个之中。这类程序错误导致的编译器错误消脊高息可能难以理解。
// 表示这一行//后面的内容羡亏注源贺释掉
/* 表示下一个*/之前的内容注释掉
#include <stdio>兄裂神 //这是注释int main(){
return 0
/* 这都是注释
这都是注释
这都是注释
这都是注释*/
}
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)