JAVA注释方法及格式

Java代码  

1. 1、单行(single-line)--短注释：//……      
2. 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。   
3. 注释格式：/* 注释内容 */   
4.   
5. 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。   
6. 注释格式：// 注释内容   
7.      
8. 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。   
9. 注释格式：代码 + 8（至少4）个空格 + // 注释内容   
10. 2、块(block)--块注释：/*……*/   
11. 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：   
12. /*  
13.   * 注释内容  
14.   */   
15. 3、文档注释：/**……*/   
16. 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符   
17. /**......*/之中，注释文档将用来生成HTML格式的代码报告，所以注释文   
18. 档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下：   
19. /**  
20. * The doGet method of the servlet.  
21. * This method is called when a form has its tag value method  
22.    * equals to get.  
23. * @param request  
24. *  the request send by the client to the server  
25. * @param response  
26. *  the response send by the server to the client  
27. * @throws ServletException  
28. *  if an error occurred  
29. * @throws IOException  
30. *  if an error occurred  
31. */   
32. public void doGet (HttpServletRequest request, HttpServletResponse response)   
33. throws ServletException, IOException {   
34.     doPost(request, response);   
35. }   
36. 前两行为描述，描述完毕后，由@符号起头为块标记注释。更多有关文档注   
37. 释和javadoc的详细资料，参见javadoc的主页： http://java.sun.com/javadoc/index.html   
38. 4、javadoc注释标签语法   
39. @author    对类的说明 标明开发该类模块的作者   
40. @version   对类的说明 标明该类模块的版本   
41. @see      对类、属性、方法的说明 参考转向，也就是相关主题   
42. @param    对方法的说明 对方法中某参数的说明   
43. @return    对方法的说明 对方法返回值的说明   
44. @exception  对方法的说明 对方法可能抛出的异常进行说明