概述
JavaDoc是什么
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
在IDEA开发环境下如何使用
一、代码的处理
- 处理规则
- 常用注释技巧
- 代码举例
二、软件使用步骤
1. 选中需要生成API的文件,点击如下截图中“Tools”中“Generate JavaDoc”选项;
2. 进入选项后有4个地方需要注意
- 在Generate JavaDoc scope选项中选择需要导出文档的 项目/类(文件)/自定义 ;
- 选择要输出文档的目标文件夹;
- 输出的文档的文字国家:中文:zh_CN ;
- 其它限制指令:-encoding UTF-8 (这部分是说开发文档中有由UTF-8写的中文,防止识别成乱码,所以将编码规则定义为UTF-8),-charset UTF-8 (表明页面所用的字符集也是UTF-8),关于编码方面的问题后期总结一个文章,先立个传送门:***(以后填坑用)***;
三、完成后的效果
打开输出的目标文件夹,就能看见index.html文件,点进去就是生成的对应选中的代码的说明文档
最后
以上就是爱笑八宝粥为你收集整理的使用IDEA生产javadocJavaDoc是什么在IDEA开发环境下如何使用的全部内容,希望文章能够帮你解决使用IDEA生产javadocJavaDoc是什么在IDEA开发环境下如何使用所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
发表评论 取消回复