2.9 注释
在整个代码中编写注释,充分地说明一个类提供了什么函数,一个方法做些什么,一个字段包含什么等,这是一种好的做法。在Java中,有两种类型的注释,它们都和C和C++中的注释有类似的语法。
传统注释。传统的注释包含在/和/之中。
单行注释。使用双斜杠(//),会使得编译器忽略一行中//之后的剩下内容。
例如,这里的一个注释描述了一个方法:
/*
toUpperCase capitalizes the characters of in a String object
*/
public void toUpperCase(String s) {
如下是一个单行注释:
public int rowCount; //the number of rows from the database
传统注释不能嵌套,这意味着
/* /* comment 1 */
comment 2 */
是无效的,因为第一个/之后的第一个/就结束了该注释。同样,上面的注释多出了一个额外的comment 2 */,这将会导致编译器错误。
另外,单行注释可以包含任何内容,包括字符/和/的序列,如下所示:
// /* this comment is okay */
时间: 2024-10-14 17:07:56