原题:源程序中加注释是帮助理解程序的重要手段,注释分为哪两类,根据查询,正确答案是序言性注释和功能性注释。
源程序又称源代码,是指未经编译的,按照一定的程序设计语言规范书写的文本文件,是一系列人类可读的计算机语言指令。计算机源程序的最终目的是将人类可读的文本翻译成为计算机可以执行的二进制指令,这种过程叫做编译,通过编译器完成。
单行注释和成对注释。单行注释以双斜线(//)开头。同一行中斜线右侧的所有内容都是注释,会被编译器略过。另一个分隔符是注释符号对(/* */),它继承自C语言。这种注释以/*开始,以*/结尾。编译器把/*和*/之间的部分都作为注释来处理
注释符号对可以放置在允许输入tab、空格或新行的任何地方。注释符号对可以跨越程序的多个行,但是不是必须这样做的。当注释符号对没有跨越多个行,通常表明内部行是多行注释的一部分。我们的样式是每行以星号开始,因此表明整个范围都是多行注释的部分。
典型情况下程序包含多种注释形式。注释符号对通常用做多行解释,而双斜线注释倾向于半行或单行注释。
程序中混合了太多的注释可能使代码混乱。通常在要解释的代码上方放置注释。
随着代码的改变,注释也应该保持更新。程序员希望注释是精确的,并且很相信它们,即使其它形式的系统文档过期了。不正确的注释比没有注释还有糟糕,因为它会误导随后的阅读者。
注释符号对不能嵌套
以/*开始的注释通常以*/结束。其结果是一个注释符号对不能出现在另一个之中。这类程序错误导致的编译器错误消息可能难以理解。
1、单行(single-line)--短注释://……单独行注释:在代码中单起一行注释,
注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/*
注释内容
*/
行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式://
注释内容
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
注释格式:代码
+
8(至少4)个空格
+
//
注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
/*
*
注释内容
*/
3、文档注释:/**……*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/
...
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)