Intellij Idea生成JavaDoc
2024-10-21 09:12:54
JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。
先看一段样例代码:
- //: object/Documentation
- /** 这是一个Javadoc测试程序
- * @author Mike Lee
- * @version 1.0
- * @since 1.5
- * */
- public class Documentation {
- /**这是一个成员变量
- * */
- public String name;
- /** a function
- * @param name 姓名
- * @return 返回name姓名
- * @throws Exception 无异常抛出
- * */
- public String function(String name) throws Exception{
- return name;
- }
- }///:~
稍微解释一下:
以//: 开始,以///:~结束。
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
idea生成HTML文档的方法:
第一步:
第二步:
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
最新文章
- 【LeetCode】Single Number I &; II &; III
- 十大关系数据库SQL注入工具一览
- [转]ubuntu 14.04 系统设置不见了
- java类与对象的动手动脑和其他小问题
- threading模块
- hbase 架构
- [VBA]根据身份证号码计算年龄的Excel函数
- JS数量输入控件
- 一名测试初学者听JAVA视频笔记(一)
- CJOJ 2044 【一本通】最长公共子序列(动态规划)
- Java连接数据库之SQLServer
- JS学习笔记Day2
- itext7知识点研究(PDF编辑)
- exBSGS·BSGS-Senior/扩展的BSGS
- mongo数据库的y2038问题
- Springboot中静态资源和拦截器处理(踩了坑)
- TCP 和 UDP 的区别( 面向连接 和 面向无连接 )
- linux下挂载U盘【转】
- java web Listener的简单使用案例
- C++11之lambda表达式解析