Java注释(八)*
在编写程序时,经常需要添加一些注释,用以描述某段代码的作用,方便理解程序。注释不是编程语句,因此被编译器忽略。
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的1/3以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦~
Java 中注释有三种类型:单行注释、多行注释、文档注释
运行结果:
注意:
多行注释可以嵌套单行注释,但是不能嵌套多行注释和文档注释。
文档注释能嵌套单行注释,不能嵌套多行注释和文档注释,一般首行和尾行也不写注释信息。
可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档,并输出到 HTML 文件中,方便记录程序信息。还可以包含一个或多个 @ 标签,每个 @ 标签都在新的一行开始。
PS:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明