用IDEA生成javadoc文档

稍微说一下常用的注解及其作用:
首先规则:以//: 开始,以///:~结束。

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

当然还有一些其他注解,例如在类的方法上:

@param 参数名

@return 返回值情况

@throws 异常抛出情况
用IDEA生成javadoc文档_第1张图片
用IDEA生成javadoc文档_第2张图片
1.选择是整个项目还是模块还是单个文件

2.文档输出路径

3.Locale 选择地区,这个决定了文档的语言,中文就是zh_CN

4.传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

你可能感兴趣的:(java,intellij-idea,java,intellij,idea)