Java程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C++中见过的,使用/*...*/和//界定的注释。文档注释(被称为"doc comments")是Java独有的,由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。
实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范,用来给出代码的总括,并提供代码自身没有提供的附加信息。
程序可有4种实现注释的风格:块(block)--块注释通常用于提供对文件,方法,数据结构和算法的描述;单行(single-line)--短注释可以显示在一行内,并与其后的代码具有一样的缩进层级;尾端(trailing)--极短的注释可以与它们所要描述的代码位于同一行;行末(end-of-line)--注释界定符"//",可注释掉整行或一行中的一部分
文档注释描述Java的类、接口、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类、接口或成员,位于声明之前。
更多有关文档注释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html
实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范,用来给出代码的总括,并提供代码自身没有提供的附加信息。
程序可有4种实现注释的风格:块(block)--块注释通常用于提供对文件,方法,数据结构和算法的描述;单行(single-line)--短注释可以显示在一行内,并与其后的代码具有一样的缩进层级;尾端(trailing)--极短的注释可以与它们所要描述的代码位于同一行;行末(end-of-line)--注释界定符"//",可注释掉整行或一行中的一部分
文档注释描述Java的类、接口、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类、接口或成员,位于声明之前。
更多有关文档注释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html