idea14生成javadoc操作及错误处理

已有 22277人阅读此文 - - 经验分享

    你是否需要把JAVA的代码注释生成一个api文件,在eclipse,intellij idea,netbeans中都提供了相应的工具进行生成,现在简单介绍一下在intellij ideak中生成javadoc的方法,在工具栏中找到”Tools”,然后“generate JavaDoc”如图1:

生成javadoc

图1 生成javadoc

然后会弹出”Specify Generate JavaDoc Scope”窗口,在这个窗口里你可以选择生成整个项目的或者某个模块的javaDoc。如图2

 

    但在使用intellij idea14导出javadoc文件时,如果注释是中文会报以下错误:错误: 编码GBK的不可映射字符。一眼看出这是一个编码问题,需要添加一个参数再告诉编译器自己使用的编码。但这段参数代码不会写,所以最终端google一下出来了。然后在如下图中的(Other command line arguments)位置填写-encoding utf-8 -charset utf-8  这段参数代码。然后点击OK,就能正常的生成javadoc代码了。但是在这个过程中可能还会有一些警告,如果你的@param中的参数未标注参数说明的话,会出现警告,如果你认为这没关系,可以忽略。

 生成javadoc

               图2生成javadoc文档选项

 

经过以上步骤就能生成编码是utf-8,像很多正规api文档一样的Html页面了。