JAVA编程规范V1.1(8)

JAVA编程规范V1.1

Example:

<pre> *

* // report longest lines

* TextFileIn f = new TextFileIn("blather.txt"); * IntVector v = new IntVector(); * int longestLine = 0 ; * boolean done = false ; * while ( ! done ) * {

* String s = f.readLine(); * * } * f.close();

* System.out.println("The longest lines are on line numbers:"); </pre>

@author Adam Baum @author Justin Case */

public class IntVector {

JAVA 方法注释

摘要描述 详细描述

参数列表，使用 @param 标签 (如果有参数) 返回值，使用 @return 标签 (如果有)

异常列表，使用 @exception 标签 (如果有异常)

如：

/** Get a copy of one int. <p>

Retrieve an int relative to the index provided.<p>

@param Index Which int (0 is the first int).<p>

@return The retrieved int or zero if Index is outside of 0..length.<p> */

public int get( int Index ) {