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 对方法的说明 对方法可能抛出的异常进行说明
分享到:
相关推荐
java 注释风格和java格式风格模版、简单好用
Java代码、注释模版格式文件
eclipse中java类注释模板,有需要的朋友可以参考使用。
在你建立的一个新的Java类时, 当类中有好多注释时你可以见其导入到Eclipse里,每次建类的时候就不用注释了。有JAVA类和方法的注释,很全面,还可以根据你自己的需要进行修改注释
1.4 JAVA注释方法及格式 . . . . . . . . . . . . . . . . . . . . . . . . .11 1.5 JAVA注释具体实现 . . . . . . . . . . . . . . . . . . . . . . . . . .13 1.6 Java 6中的性能优化 . . . . . . . . . . . . . ....
超级好用的 java 注释模板,吐血总结,整理。吐血总结,整理。
java 注释模板 java 注释模板 java 注释模板 java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板
JAVA注释模板以及详细设置解释等等。 注释模板 如何设置
有关于java的注释规范的详细描述,单行注释、多行注释、分块注释等这些java的三种注释方式
Eclipse Java注释模板设置详解
Java代码注释率检查器
Java注释的良好习惯,方便项目的交接和事后的维护与整理,是一个很好的帮助自己养成编码习惯的工具,效果图在我的博文有记录,有需要的伙伴可以自行下载哦~
Eclipse Java 注释模板,设置后可以使用快捷键快速生成文档注释,版本信息等。
Java中如何给自己写的方法添加简洁的注释,以便以后方便自己使用。上传这个demo记录下如何给方法添加注释。
这是本人自己开发的一款java代码注释统计工具,支持统计总行数,总代码行数,总注释行数,注释率,注释合格率自定义,统计详细,单个文件统计情况,可导出统计报告等! 注:本软件未捆绑jre(java环境),需要在已...
MyEclipse中设置java注释模板的方法.docx
java编码规范及注释快捷键.doc
满足IntelliJ、eclipse、As等编辑器的Java开发注释模板,可以方便的管理自己的代码,包括类注释、方法注释、接口注释等
能良好的解决使用jd-gui.exe软件反编译程序后,在生成的java文件前部存在的注释: 1.仅支持删除java文件和txt文件;(如果想支持其他格式的文件,请用"."+格式后缀名替换clear_annot类的103行".txt"); 2.仅支持删除...