Java注释详解
2015-08-20 10:30
429 查看
在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!
Java 中注释有三种类型:单行注释、多行注释、文档注释
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
打开首页,查看下生成的 API 文档
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!
Java 中注释有三种类型:单行注释、多行注释、文档注释
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
打开首页,查看下生成的 API 文档
PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
相关文章推荐
- 从零开始学JAVA DAY3
- 浅析Java内存模型
- java-httpclient-18k 改进一,支持http异步,回调,https
- 【Spring】Spring下配置注解事务学习笔记
- LDA主题模型的java代码实现
- extjs+java开发框架搭建
- Eclipse快捷键大全(转载)
- Struts2笔记――8.类型转换
- SpringMVC简介、工作流程、配置
- Java问题排查(运维篇)
- spring支持的websocket
- JAVA 面向对象( 类和对象)
- Failed to read artifact descriptor for org.eclipse.tycho 错误
- spring支持的websocket
- Java线程状态的转换
- Struts2笔记――9.输入校验
- Java解析xml文件四种方式
- win7下使用Eclipse双向断点调试JAVA+NDK的环境配置
- 深入浅出的理解框架(Struts2、Hibernate、Spring)与 MVC 设计模式
- Struts2配置事项