JAVA注释方法及格式
来源:互联网 发布:ubuntu安装后的20件事 编辑:程序博客网 时间:2024/04/29 01:32
1、单行(single-line)--短注释://……
单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/* 注释内容 */
行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式:// 注释内容
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
注释格式:代码 + 8(至少4)个空格 + // 注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
/*
* 注释内容
*/
3、文档注释:/**……*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文
档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method
* equals to get.
* @param request
* the request send by the client to the server
* @param response
* the response send by the server to the client
* @throws ServletException
* if an error occurred
* @throws IOException
* if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
前两行为描述,描述完毕后,由@符号起头为块标记注释。更多有关文档注
释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html
4、javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
转自:http://fhqllt.javaeye.com/blog/465748
- JAVA注释方法及格式
- JAVA注释方法及格式
- java 注释的格式
- JAVA注释格式说明
- JAVA注释格式,自用
- JAVA 注释格式
- Java注释及文档注释
- Eclipse中代码格式及类和方法等注释设置及对应快捷键
- java文档注释 编写格式
- 设置Java文件注释格式
- java注释的标准格式
- java API 部分注释格式
- MyEclipse6.5 注释类及方法等格式设置(Code Templates)
- MyEclipse 注释类及方法等格式设置(Code Templates)
- java.util.Properties类,保存时保留注释及格式不变
- Java文档注释方法
- java注释方法
- java 注释方法
- Pyke 逻辑编程入门(14):知识库之“事实库”
- 表单验证
- [Trouble Shoot]Struts2和Tile2
- 在java代码中sql语句出现start before result set的错误解决办法
- 播放歌曲文件
- JAVA注释方法及格式
- java爱好者
- 愿昨天成为美好的回忆,让我忘了你是谁
- 想了很久
- htons和htonl
- pb开发
- 好像是该认真学习的时候到了
- 转了一个女人的帖子。呵呵,我们也多学学如何做生意!
- C语言难点专题——复杂的函数声明