标签:JavaDoc javadoc IDEA API 使用 注解 Documented
目录
1、IDEA如何使用javadoc
Locale :可选填项,表示的是需要生成的 JavaDoc 以何种语言版本展示,根据 javadoc.exe 的帮助说明,这其实对应的就是 javadoc.exe 的 -locale 参数,如果不填,默认可能是英文或者是当前操作系统的语言,既然是国人,建议在此填写 zh_CN,这样生成的 JavaDoc 就是中文版本的,当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。
Other command line arguments:可选填项,非常重要,是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置,只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数:
-encoding UTF-8 -charset UTF-8 -windowtitle "你的文档在浏览器窗口标题栏显示的内容" -link http://docs.oracle.com/javase/7/docs/api
然后点击OK,就可以去选择的目录下打开index.html。
IDEA简单使用javadoc工具教程就到这里了。
2、@Documente
2.1 未使用@Documented注解
2.2 使用了@Documented注解
所以总结就是:在自定义注解的时候可以使用@Documented来进行标注,如果使用@Documented标注了,在生成javadoc的时候就会把@Documented注解给显示出来,反之就不显示!
3、总结
3.1 IDEA使用javadoc工具步骤: Tools->Generate JavaDoc->配置好相关事项
3.2 如果使用@Documented标注了,在生成javadoc的时候就会把@Documented注解给显示出来,反之就不显示!
标签:JavaDoc,javadoc,IDEA,API,使用,注解,Documented 来源: https://blog.csdn.net/weixin_53041251/article/details/122333117
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。