java回忆录—注释
java2016-08-02
java中的注释分为三种:
1、单选注释:符号是://
2、块注释: 符号是: /* */ 可以跨多行
3、javadoc注释: 符号是: /** */ 可以跨多行, 生成javadoc时,这样的注释会被生成标准的javaapi注释。
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
这些注释都没什么讲的,前两种比较简单,讲一下第三种,第三种注释为文档注释,是用来生成 javaapi 注释的。第三种一般用类上或方法上。
那么怎么使用呢?
例子:
Test.java
package com.briup;
/**
* 测试类
* @author Administrator
*
*/
public class Test {
/**
* 测试主方法
* @param args
*/
public static void main(String[] args) {
}
/**
* 这个方法是查询名字的
* @param age 年龄
* @return 返回名字
*/
public String getName(int age) {
return null;
}
}
使用Eclipse 的话点击Project –> Generate Javadoc…–>
然后完成即可。
生成之后打开你生成的文档:
打开 Index.html
这时可以看到像API一样的东西,但是你可能会看到你刚才添加的文档注释会为乱码,这是因为生成文档的时候没有指定编码。
乱码的解决
关于在eclipse中生成doc时产生乱码的解决办法
在使用eclipse generate javadoc是发生乱码(我的工程编码采用utf-8),如果要正常的生成项目文档,请使用下面的javadoc
参数 -encoding UTF-8 -charsetUTF-8
也就是:javadoc -encoding UTF-8 -charset UTF-8
在eclipse中设置如下:
这个是在eclipse生成文档的最后一步中设置
这时你再打开index.html看时没有了乱码: