在IntelliJ IDEA中为自己设计的类库生成JavaDoc的方法示例
因为某个项目需要，为团队其他兄弟姐妹开发了一个XML分析处理器，并将其设计为一个类库，提供相应的API接口。为了方便大家的使用，需要生成对应的JavaDoc帮助文档，就像JavaSE标准库提供的JavaDoc那样。我的开发工具为IntelliJIDEA12.1.6，本身提供了很好的JavaDoc生成功能，以及标准JavaDoc注释转换功能，其实质是在代码编写过程中，按照标准JavaDoc的注释要求，为需要暴露给使用者的类、方法以及其他成员编写注释。然后使用IDEA的功能自动调用javadoc.exe（JDK自带的工具）根据源代码中的注释内容自动生成JavaDoc文档（超文本格式）。标准JavaDoc的注释规则，大家可以在网上很容易搜索到，这里有几点倒是要特别注意一下：
1.IDEA的JavaDoc生成功能在菜单Tools->GenerateJavaDoc项里面。
2.点击上述菜单项后，会出现生成JavaDoc的对话框，一般的选项都很直观，不必细说。但是要注意生成JavaDoc的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的Java源代码文件，不推荐以Project为JavaDoc生成的源范围。
3.里面有一个Locale可选填项，表示的是需要生成的JavaDoc以何种语言版本展示，根据javadoc.exe的帮助说明，这其实对应的就是javadoc.exe的-locale参数，如果不填，默认可能是英文或者是当前操作系统的语言，既然是国人，建议在此填写zh_CN，这样生成的JavaDoc就是中文版本的，当然指的是JavaDoc的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。
4.还有一个“Othercommandlinearguments:”可选填项，非常重要，是填写直接向javadoc.exe传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向javadoc.exe传递。这里必须要填写如下参数：
-encodingUTF-8-charsetUTF-8-windowtitle"你的文档在浏览器窗口标题栏显示的内容"-linkhttp://docs.oracle.com/javase/7/docs/api
5.第一个参数-encodingUTF-8表示你的源代码（含有符合JavaDoc标准的注释）是基于UTF-8编码的，以免处理过程中出现中文等非英语字符乱码；第二个参数-charsetUTF-8表示在处理并生成JavaDoc超文本时使用的字符集也是以UTF-8为编码，目前所有浏览器都支持UTF-8，这样最具有通用性，支持中文非常好；第三个参数-windowtitle表示生成的JavaDoc超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容；第四个参数-link很重要，它表示你生成的JavaDoc中涉及到很多对其他外部Java类的引用，是使用全限定名称还是带有超链接的短名称，举个例子，我创建了一个方法publicvoidfunc(Stringarg)，这个方法在生成JavaDoc时如果不指定-link参数，则JavaDoc中对该方法的表述就会自动变为publicvoidfunc(java.lang.Stringarg)，因为String这个类对我自己实现的类来讲就是外部引用的类，虽然它是Java标准库的类。如果指定了-linkhttp://docs.oracle.com/javase/7/docs/api参数，则javadoc.exe在生成JavaDoc时，会使用String这样的短名称而非全限定名称java.lang.String，同时自动为String短名称生成一个超链接，指向官方JavaSE标准文档http://docs.oracle.com/javase/7/docs/api中对String类的详细文档地址。-link实质上是告诉javadoc.exe根据提供的外部引用类的JavaDoc地址去找一个叫package-list的文本文件，在这个文本文件中包含了所有外部引用类的全限定名称，因此生成的新JavaDoc不必使用外部引用类的全限定名，只需要使用短名称，同时可以自动创建指向其外部引用JavaDoc中的详细文档超链接。每个JavaDoc都会在根目录下有一个package-list文件，包括我们自己生成的JavaDoc。
JavaDoc生成完毕，即可在其根目录下找到index.html文件，打开它就可以看到我们自己的标准JavaDocAPI文档啦。
javadoc常用标识
@author作者
@version版本号
@param参数名描述方法的入参名及描述信息，如入参有特别要求，可在此注释。
@return描述对函数返回值的注释
@deprecated过期文本标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。
@throws异常类名构造函数或方法所会抛出的异常。
@exception异常类名同@throws。
@see引用查看相关内容，如类、方法、变量等。
@since描述文本API在什么程序的什么版本后开发支持。
{@link包.类#成员标签}链接到某个特定的成员对应的文档中。
{@value}当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。
到此这篇关于在IntelliJIDEA中为自己设计的类库生成JavaDoc的方法示例的文章就介绍到这了,更多相关IDEA生成JavaDoc内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。