和大多数编程语言一样,Java中的注释不会出现在可执行程序中。因此,您可以在源程序中添加任意多的注释,而不必担心会使可执行代码膨胀。在Java中,有3种标记注释的方法。第一种方法//,注释内容要放在//之后,并在行尾结束。System.out.println("你好,世界!");//'你好世界!'output第二种方法/**/,当注释较长时,可以用/*和*/把注释括起来。/*多行注释。*/第三种方式/***/,这种注释是文档注释。以/**开始,以*/结束。/**文档注释。*/文档注释主要负责描述类、域、方法、构造函数等,可以被javadoc工具提取生成HTML文档,与源文件保存在一处。修改源码后,重新运行javadoc可以保持源文件和文档的一致性。出现在文档注释中的以@开头的标签称为Javadoc文档标签。如下:标签说明@author标签作者,多个作者使用多个@author。例如,@authorMony@version标记当前版本的描述。例如,@version1.0@since标记引入该功能的版本描述。例如,@since版本1.7.1。@deprecated标记不再使用的类、方法或变量。@see在该标记之后添加与之关联的项目。可用于类和方法。@param标记参数说明。泛型类型在泛型类中描述;方法后面是参数名,参数是描述的。@return这个标签描述了方法和返回值。@throws标记抛出的异常类型并描述异常。@exception的使用方式与@throws标签相同。@link被标记为链接,用于指向其他类或方法。@value标记一个常量的值,常量必须有静态属性。@code将文本标记为代码样式。除了标签,还可以使用
等HTML标签来分隔段落,
- 标签列表和
- 标签列表选项,但不要使用与文档冲突的
或
标签格式。/***Arithmetic***这是一个描述四个操作的类*
***@authorhireny*@version1.0*/publicclassArithmetic{/***这是一个方法来做addition**@paramasummand*@parambaddend*@return运算后的值*/publicstaticintadd(inta,intb){returna+b;}/***这是一个做减法的方法*@paramaminuend*@parambsubtraction*@return运算后的值*/publicstaticintsub(inta,intb){returna-b;}/***这是一个做乘法的方法**@paramamultiplier*@parambmultiplier*@return运算后的值*/publicstaticintmult(inta,intb){returna*b;}/***这是一个做除法的方法**@paramadivisor*@parambdivisor*@return运算后的值*/publicstaticintdiv(inta,intb){返回a/b;}/***这是一个除法取余的方法**@paramadivisor*@parambdivisor*@return运算后的值*/publicstaticintrem(inta,intb){returna%b;}}在一个类中定义文档注释后,就可以运行源文件所在目录下的javadocArithmetic.java,生成源文件的HTML文档。GBK编码冲突,可以使用其他编码集如javadocArithmetic.java-encodingUTF-8-charsetUTF-8下面是运行后生成的文件。而如果要为某个包生成注释,则需要在每个包下添加package.html或package-info.java;您还可以对包中的源文件进行概述注释。如下图:但是这种方式生成的文件会放在当前目录下,造成包下的文件混乱。因此,在生成文件时,使用-d选项增加文件目录javadoc-ddocDirectory*.java。javadoc命令有很多作用,生成文档也可以使用IDE提供的生成Javadoc文档的好工具。更多内容请关注公众号《海人的故事》