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

原创粉丝点击