Java中生成帮助文档
2015-10-26 21:32
274 查看
如何在Java中使用注释
在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!
Java 中注释有三种类型:单行注释、多行注释、文档注释
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213120950-409082794.jpg)
运行结果: Hello Imooc!
看:被注释的代码块在程序运行时是不会被执行的~~
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213125794-1026650202.jpg)
打开首页,查看下生成的 API 文档
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213129325-1874232316.jpg)
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!
Java 中注释有三种类型:单行注释、多行注释、文档注释
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213120950-409082794.jpg)
运行结果: Hello Imooc!
看:被注释的代码块在程序运行时是不会被执行的~~
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213125794-1026650202.jpg)
打开首页,查看下生成的 API 文档
![](http://images2015.cnblogs.com/blog/578592/201510/578592-20151026213129325-1874232316.jpg)
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
相关文章推荐
- JAVA学习的一些笔记
- win7+mingw+opengl+eclipse
- JAVA用POI读取和创建2003和2007版本Excel完美示例
- java简单的各种进制转换
- 01-MyEclipse新建JavaWeb项目并发布到Tomcart下
- Spring 读取XML配置文件的两种方式
- JAVA-部署-摘
- 常用的mimeType,以及java获取mime类型
- Java 反射实例
- springmvc请求接收参数的几种方法
- JAVA学习课第五 — IO流程(九)文件分割器合成器
- 大龄屌丝自学笔记--Java零基础到菜鸟--037
- Java Swing 之JTable及其简单的用法
- Java Swing 之JTable及其简单的用法
- Java实现给定一个日期 求出这个日期是这一年中的第几天
- [转]struts2接收参数的几种形式
- Java中的设计模式
- java之迭代器
- Java虚拟机原理----JVM运行时数据区(转)
- Eclipse、IDEA环境下设置jvm默认编码