根据已有的项目，生成java doc

使用javadoc时出现“编码 GBK 的不可映射字符 ”问题

完善api-doc，用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”，很是恼火。其实是字符编码问题。 
打开eclipse，project -> Generate javadoc 一项一项的选你要输出javadoc的项目，在VM设置中加入以下代码

 

-encoding utf-8 -charset utf-8

 

或者使用

-docencoding UTF-8 -encoding UTF-8

 

 

 

也都是可以的。

选择所需之修饰符范围

-public 仅显示 public 类和成员 
    -protected 显示 protected/public 类和成员 (缺省)
    -package 显示 package/protected/public 类和成员
    -private 显示所有类和成员

代码中需要增加注释之位置

注意：所有需要出现在javadoc中的注释，都是需要使用/**   comment  */的格式出现。

类定义的上方

在这里出现的注释，会出现在两个地方：一个是类列表中如果包含该类时，会出现注释的第一句话在右边；二是在该类的详细说明处，会出现所有的注释内容。

注意在注释和类定义之间，不要有空行。

方法定义的上方

在这里出现的注释，会出现在两个地方：一个是方法列表中如果包含该方法时，会出现注释的第一句话在右边；二是在该方法的详细说明处，会出现所有的注释内容。

注意在注释和方法定义之间，不要有空行。

参数定义的上方

在这里出现的注释，会出现在两个地方：一个是参数列表中如果包含该参数时，会出现注释的第一句话在右边；二是在该参数的详细说明处，会出现所有的注释内容。

注意在注释和方法定义之间，不要有空行。

 

 注意：注释的第一句话的定义，在javadoc中定义是以“.”来定义的，并不是“。”。所以如果需要使用中文，你要注意了。