JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

先看一段样例代码:

  1. //: object/Documentation
  2. /** 这是一个Javadoc测试程序
  3. *  @author Mike Lee
  4. *  @version 1.0
  5. *  @since 1.5
  6. * */
  7. public class Documentation {
  8. /**这是一个成员变量
  9. * */
  10. public String name;
  11. /** a function
  12. * @param name 姓名
  13. * @return 返回name姓名
  14. * @throws  Exception 无异常抛出
  15. * */
  16. public String function(String name) throws Exception{
  17. return name;
  18. }
  19. }///:~

稍微解释一下:

以//: 开始,以///:~结束。

@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

最新文章

  1. 【LeetCode】Single Number I & II & III
  2. 十大关系数据库SQL注入工具一览
  3. [转]ubuntu 14.04 系统设置不见了
  4. java类与对象的动手动脑和其他小问题
  5. threading模块
  6. hbase 架构
  7. [VBA]根据身份证号码计算年龄的Excel函数
  8. JS数量输入控件
  9. 一名测试初学者听JAVA视频笔记(一)
  10. CJOJ 2044 【一本通】最长公共子序列(动态规划)
  11. Java连接数据库之SQLServer
  12. JS学习笔记Day2
  13. itext7知识点研究(PDF编辑)
  14. exBSGS·BSGS-Senior/扩展的BSGS
  15. mongo数据库的y2038问题
  16. Springboot中静态资源和拦截器处理(踩了坑)
  17. TCP 和 UDP 的区别( 面向连接 和 面向无连接 )
  18. linux下挂载U盘【转】
  19. java web Listener的简单使用案例
  20. C++11之lambda表达式解析

热门文章

  1. ssh配置含义解释
  2. linux中at命令
  3. Django和Flask的区别以及运行流程
  4. 成功者的特点 VS 失败者的特点
  5. Solidworks如何使用Toolbox
  6. (转)来自互联网巨头的46个用户体验面试问题(谷歌,亚马逊,facebook及微软)
  7. 微软Azure公有云个人用户是否能支付得起?
  8. 在MyEclipse上部署Tomcatserver
  9. HttpClient 模拟登录搜狐微博
  10. iPhone X