javadoc生成注释

javadoc做注释
一. Java 文档

1. // 注释一行    
2. /* ...... */  注释若干行    
3. /** ...... */  注释若干行，并写入 javadoc 文档   

通常这种注释的多行写法如下：

1. /**   
2. * .........   
3. * .........   
4. */    

javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为 “源文件名.java”的 java 源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。

二. 文档注释的格式

1. 文档和文档注释的格式化

生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 <br>，如果要分段，就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。如

1. /**   
2. * This is first line. <br>   
3. ***** This is second line. <br>   
4. This is third line.   
5. */    

2. 文档注释的三部分
先举例如下

1. /**   
2. * show 方法的简述.   
3. * <p>show 方法的详细说明第一行<br>   
4. * show 方法的详细说明第二行   
5. * @param b true 表示显示，false 表示隐藏   
6. * @return 没有返回值   
7. */     
8. public   void  show( boolean  b) {    
9. frame.show(b);    
10. }    
11.   

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。

1. * show 方法的简述.    
2. * <p>show 方法的详细说明第一行<br>    
3. * show 方法的详细说明第二行   

简述也在其中。这一点要记住了

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。

1. *  @param  b  true  表示显示， false  表示隐藏    
2. *  @return  没有返回值   

 

三. 使用 javadoc 标记

1. javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成    
2. javadoc 标记有如下一些：    
3. @author  标明开发该类模块的作者    
4. @version  标明该类模块的版本    
5. @see  参考转向，也就是相关主题    
6. @param  对方法中某参数的说明    
7. @return  对方法返回值的说明    
8. @exception  对方法可能抛出的异常进行说明    
9.   
10. @author  作者名    
11. @version  版本号    

其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效

使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下：

1. @param  参数名 参数说明    
2. @return  返回值说明    
3. @exception  异常类名 说明    

四. javadoc 命令
用法： 　　

1. javadoc [options] [packagenames] [sourcefiles]   

选项：

1. - public  仅显示  public  类和成员    
2. - protected  显示  protected / public  类和成员 (缺省)    
3. - package  显示  package / protected / public  类和成员    
4. - private  显示所有类和成员    
5. -d <directory> 输出文件的目标目录    
6. -version 包含  @version  段    
7. -author 包含  @author  段    
8. -splitindex 将索引分为每个字母对应一个文件    
9. -windowtitle <text> 文档的浏览器窗口标题   

javadoc 编译文档时可以给定包列表，也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下：

1. 　　fancy.Editor    
2. 　　fancy.Test    
3. 　　fancy.editor.ECommand    
4. 　　fancy.editor.EDocument    
5. 　　fancy.editor.EView   

可以直接编译类：

1. javadoc fancy/Test.java fancy/Editor.java fancy/editor/ECommand.java fancy/editor/EDocument.java fancy/editor/EView.java   

也可以是给出包名作为编译参数，如：javadoc fancy fancy.editor
可以自己看看这两种方法的区别

到此为止javadoc就简单介绍完了，想要用好她还是要多用，多参考标准java代码
Java代码规范

1. --注释    
2.   
3. @author  LEI    
4.   
5. @version   1.10   2005 - 09 - 01     

1 注释文档的格式

注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。

例如：

1. /**   
2.  
3. * The doGet method of the servlet.   
4.  
5. * This method is called when a form has its tag value method equals to get.   
6.  
7. *   
8.  
9. * @param request   
10.  
11. * the request send by the client to the server   
12.  
13. * @param response   
14.  
15. * the response send by the server to the client   
16.  
17. * @throws ServletException   
18.  
19. * if an error occurred   
20.  
21. * @throws IOException   
22.  
23. * if an error occurred   
24.  
25. */     
26.   
27. public   void  doGet (HttpServletRequest request, HttpServletResponse response)    
28.   
29. throws  ServletException, IOException {    
30.   
31. doPost(request, response);    
32.   
33. }    
34.   

前两行为描述，描述完毕后，由@符号起头为块标记注视。

2 注释的种类
2.1 文件头注释

文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。

例如：

1. /*    
2.   
3. * Created on  2005 - 7 - 2     
4.   
5. * /    

2.2 类、接口注释

类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。

例如：

1. /**Title: XXXX DRIVER 3.0   
2. *Description: XXXX DRIVER 3.0   
3. *Copyright: Copyright (c) 2003   
4. *Company:XXXX有限公司   
5. *   
6. * @author Java Development Group   
7. * @version 3.0   
8. */     
9.   

例如：

1. /**   
2. * A class representing a window on the screen.   
3. * For example:   
4. *   
5. * Window win = new Window(parent);   
6. * win.show();   
7. *   
8. *   
9. * @author Sami Shaio   
10. * @version %I%, %G%   
11. * @see java.awt.BaseWindow   
12. * @see java.awt.Button   
13. */     
14.   
15. class  Window  extends  BaseWindow {    
16.   
17. ...    
18.   
19. }    
20.   

 

2.3 构造函数注释

构造函数注释采用 /** … */，描述部分注明构造函数的作用，不一定有块标记部分。

例如：

1. /**   
2.  
3. * 默认构造函数   
4.  
5. */     

有例如：

1. /**   
2.  
3. * 带参数构造函数,初始化模式名,名称和数据源类型   
4.  
5. *   
6.  
7. * @param schema   
8.  
9. * Ref 模式名   
10.  
11. * @param name   
12.  
13. * Ref 名称   
14.  
15. * @param type   
16.  
17. * byVal 数据源类型   
18.  
19. */     
20.   

 

2.4 域注释

域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/* … */的注释会被忽略。

例如：

1. /* 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */     
2.   
3. boolean  isTrigerSuccess =  false ;    

又例如：

1. /** 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */     
2.   
3. boolean  isTrigerSuccess =  false ;    
4.   

再例如：

1. /**   
2.  
3. * The X-coordinate of the component.   
4.  
5. *   
6.  
7. * @see #getLocation()   
8.  
9. */     
10.   
11. int  x =  1263732 ;    
12.   

 

2.5 方法注释

方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如：

1. /**   
2.  
3. * 设置是否有外码约束   
4.  
5. *   
6.  
7. * @param conn   
8.  
9. * Connection 与数据库的连接   
10.  
11. */     
12.   

 

2.6 定义注释

规则同域注释。

3 注释块标记
3.1 标记的顺序

块标记将采用如下顺序：

1. …    
2.   
3. *    
4.   
5. *  @param  (classes, interfaces, methods and constructors only)    
6.   
7. *  @return  (methods only)    
8.   
9. *  @exception  ( @throws  is a synonym added in Javadoc  1.2 )    
10.   
11. *  @author  (classes and interfaces only, required)    
12.   
13. *  @version  (classes and interfaces only, required. See footnote  1 )    
14.   
15. *  @see     
16.   
17. *  @since     
18.   
19. *  @serial  (or  @serialField  or  @serialData )    
20.   
21. *  @deprecated  (see How and When To Deprecate APIs)    
22.   
23. * …    
24.   

一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：

1. @author  按照时间先后顺序（chronological）    
2.   
3. @param  按照参数定义顺序（declaration）    
4.   
5. @throws  按照异常名字的字母顺序（alphabetically）    
6.   
7. @see  按照如下顺序：    
8.   
9. @see  #field    
10.   
11. @see  #Constructor(Type, Type...)    
12.   
13. @see  #Constructor(Type id, Type id...)    
14.   
15. @see  #method(Type, Type,...)    
16.   
17. @see  #method(Type id, Type, id...)    
18.   
19. @see  Class    
20.   
21. @see  Class#field    
22.   
23. @see  Class#Constructor(Type, Type...)    
24.   
25. @see  Class#Constructor(Type id, Type id)    
26.   
27. @see  Class#method(Type, Type,...)    
28.   
29. @see  Class#method(Type id, Type id,...)    
30.   
31. @see   package .Class    
32.   
33. @see   package .Class#field    
34.   
35. @see   package .Class#Constructor(Type, Type...)    
36.   
37. @see   package .Class#Constructor(Type id, Type id)    
38.   
39. @see   package .Class#method(Type, Type,...)    
40.   
41. @see   package .Class#method(Type id, Type, id)    
42.   
43. @see   package     
44.   

3.2 标记介绍
3.2.1 @param标记

@param后面空格后跟着参数的变量名字（不是类型），空格后跟着对该参数的描述。

在描述中第一个名字为该变量的数据类型，表示数据类型的名次前面可以有一个冠词如：a,an,the。如果是int类型的参数则不需要注明数据类型。例如：

1. …    
2.   
3. *  @param  ch the  char  用用来……    
4.   
5. *  @param  _image the image 用来……    
6.   
7. *  @param  _num 一个数字……    
8.   
9. …    

对于参数的描述如果只是一短语，最好不要首字母大写，结尾也不要句号。

对于参数的描述是一个句子，最好不要首字母大写，如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话，必须用句号来结束句子。（英文的句号）

公司内部添加ByRef和ByVal两个标记，例如：

1. *  @param  _image the image ByRef 用来……   

说明该参数是引用传递（指针），ByVal可以省略，表示是值传递。

3.2.2 @return标记

返回为空（void）的构造函数或者函数，@return可以省略。

如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息。

必要的时候注明特殊条件写的返回值。

3.2.3 @throws 标记

@throws以前使用的是@exception。

@throws的内容必须在函数的throws部分定义。

3.2.4 @author标记

类注释标记。

函数注释里面可以不出现@author。

3.2.5 @version

类注释标记。

函数注释里面可以不出现@version

3.2.6 @since

类注释标记。

标明该类可以运行的JDK版本

例如：

1. @since  JDK1. 2    

3.2.7 @deprecated

由于某种原因而被宣布将要被废弃的方法。

1. /**   
2.  
3. * @deprecated As of JDK 1.1, replaced by   
4.  
5. * setBounds   
6.  
7. * @see #setBounds(int,int,int,int)   
8.  
9. */     
10.   

 

3.2.8 @link标记

语法：{@link package.class#member label}

Label为链接文字。

package.class#member将被自动转换成指向package.class的member文件的URL。

4 HTML代码的使用

在注释描述部分可以使用HTML代码。

…
表示段落

    * ….

表示自动标号

5 注释示例

1. /**   
2.  
3. * Graphics is the abstract base class for all graphics contexts   
4.  
5. * which allow an application to draw onto components realized on   
6.  
7. * various devices or onto off-screen images.   
8.  
9. * A Graphics object encapsulates the state information needed   
10.  
11. * for the various rendering operations that Java supports. This   
12.  
13. * state information includes:   
14.  
15. *   
16.  
17. # * The Component to draw on   
18.  
19. # * A translation origin for rendering and clipping coordinates   
20.  
21. # * The current clip   
22.  
23. # * The current color   
24.  
25. # * The current font   
26.  
27. # * The current logical pixel operation function (XOR or Paint)   
28.  
29. # * The current XOR alternation color   
30.  
31. * (see setXORMode)   
32.  
33. *   
34.  
35. *   
36.  
37. * Coordinates are infinitely thin and lie between the pixels of the   
38.  
39. * output device.   
40.  
41. * Operations which draw the outline of a figure operate by traversing   
42.  
43. * along the infinitely thin path with a pixel-sized pen that hangs   
44.  
45. * down and to the right of the anchor point on the path.   
46.  
47. * Operations which fill a figure operate by filling the interior   
48.  
49. * of the infinitely thin path.   
50.  
51. * Operations which render horizontal text render the ascending   
52.  
53. * portion of the characters entirely above the baseline coordinate.   
54.  
55. *   
56.  
57. * Some important points to consider are that drawing a figure that   
58.  
59. * covers a given rectangle will occupy one extra row of pixels on   
60.  
61. * the right and bottom edges compared to filling a figure that is   
62.  
63. * bounded by that same rectangle.   
64.  
65. * Also, drawing a horizontal line along the same y coordinate as   
66.  
67. * the baseline of a line of text will draw the line entirely below   
68.  
69. * the text except for any descenders.   
70.  
71. * Both of these properties are due to the pen hanging down and to   
72.  
73. * the right from the path that it traverses.   
74.  
75. *   
76.  
77. * All coordinates which appear as arguments to the methods of this   
78.  
79. * Graphics object are considered relative to the translation origin   
80.  
81. * of this Graphics object prior to the invocation of the method.   
82.  
83. * All rendering operations modify only pixels which lie within the   
84.  
85. * area bounded by both the current clip of the graphics context   
86.  
87. * and the extents of the Component used to create the Graphics object.   
88.  
89. *   
90.  
91. * @author Sami Shaio   
92.  
93. * @author Arthur van Hoff   
94.  
95. * @version %I%, %G%   
96.  
97. * @since 1.0   
98.  
99. */     
100.   
101. public   abstract   class  Graphics {    
102.   
103. /**   
104.  
105. * Draws as much of the specified image as is currently available   
106.  
107. * with its northwest corner at the specified coordinate (x, y).   
108.  
109. * This method will return immediately in all cases, even if the   
110.  
111. * entire image has not yet been scaled, dithered and converted   
112.  
113. * for the current output device.   
114.  
115. *   
116.  
117. * If the current output representation is not yet complete then   
118.  
119. * the method will return false and the indicated   
120.  
121. * {@link ImageObserver} object will be notified as the   
122.  
123. * conversion process progresses.   
124.  
125. *   
126.  
127. * @param img the image to be drawn   
128.  
129. * @param x the x-coordinate of the northwest corner   
130.  
131. * of the destination rectangle in pixels   
132.  
133. * @param y the y-coordinate of the northwest corner   
134.  
135. * of the destination rectangle in pixels   
136.  
137. * @param observer the image observer to be notified as more   
138.  
139. * of the image is converted. May be   
140.  
141. * null   
142.  
143. * @return true if the image is completely   
144.  
145. * loaded and was painted successfully;   
146.  
147. * false otherwise.   
148.  
149. * @see Image   
150.  
151. * @see ImageObserver   
152.  
153. * @since 1.0   
154.  
155. */     
156.   
157. public   abstract   boolean  drawImage(Image img,  int  x,  int  y,    
158.   
159. ImageObserver observer);    
160.   
161. /**   
162.  
163. * Dispose of the system resources used by this graphics context.   
164.  
165. * The Graphics context cannot be used after being disposed of.   
166.  
167. * While the finalization process of the garbage collector will   
168.  
169. * also dispose of the same system resources, due to the number   
170.  
171. * of Graphics objects that can be created in short time frames   
172.  
173. * it is preferable to manually free the associated resources   
174.  
175. * using this method rather than to rely on a finalization   
176.  
177. * process which may not happen for a long period of time.   
178.  
179. *   
180.  
181. * Graphics objects which are provided as arguments to the paint   
182.  
183. * and update methods of Components are automatically disposed   
184.  
185. * by the system when those methods return. Programmers should,   
186.  
187. * for efficiency, call the dispose method when finished using   
188.  
189. * a Graphics object only if it was created directly from a   
190.  
191. * Component or another Graphics object.   
192.  
193. *   
194.  
195. * @see #create(int, int, int, int)   
196.  
197. * @see #finalize()   
198.  
199. * @see Component#getGraphics()   
200.  
201. * @see Component#paint(Graphics)   
202.  
203. * @see Component#update(Graphics)   
204.  
205. * @since 1.0   
206.  
207. */     
208.   
209. public   abstract   void  dispose();    
210.   
211. /**   
212.  
213. * Disposes of this graphics context once it is no longer   
214.  
215. * referenced.   
216.  
217. *   
218.  
219. * @see #dispose()   
220.  
221. * @since 1.0   
222.  
223. */     
224.   
225. public   void  finalize() {    
226.   
227. dispose();    
228.   
229. }    
230.   
231. }    
232.