Idea自动生成注释、创建javadoc

1、类注释

setting-editor-file and code templates-file-class作如下设置，scala class、scala object也在file下对应模块中设置，新建类时即会生成

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**  
  * 
  * @author ${USER}
  * @date ${DATE}${TIME}
  */
public class ${NAME} {
}

2、方法注释

setting-editor-live templates，"+"新建live templates，设置templates text如下，change选择java下的所有项，没有throw和return的可以删除该行注释

**
 * 
 $params$ 
 $return$ 
 * @author xzq
 * @throws 
 * @date $date$ $time$
 */

edit variable中设置如下

1. params default value：

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());

2. return default value：

groovyScript("def returnType = \"${_1}\"; def result = '* @return ' + returnType; return result;", methodReturnType());

3. date expression：date()
4. time expression：time()

在方法外部输入"/*"，按tab后即可生成

3、生成javadoc

tool-generate javadoc
选择whole project，指定输出文件夹output directory，locale选zh_CN即生成中文html，other command arguments设置如下，其中-tag是自定义的标签，将在javadoc中显示

-encoding UTF-8 -charset UTF-8 -tag date:a:"date"

注意事项：

• 无返回值的方法提示@return 用法有误，直接删除该@return 注释即可
• 取消勾选include test source即可剔除test类
• @throws 每行只能写一个exception，如有多个exception需分为多行@throws
• 描述性注释应放在注释的前面，不需要用@***修饰