教你写好代码注释

    /**     * Returns the length of this string.     * The length is equal to the number of <a href="Character.html#unicode">Unicode     * code units</a> in the string.     *     * @return  the length of the sequence of characters represented by this     *          object.     */    public int length() {        return value.length;    }

public final class String    implements java.io.Serializable, Comparable<String>, CharSequence {    /** The value is used for character storage. */    private final char value[];
    /** Cache the hash code for the string */    private int hash; // Default to 0
    /** use serialVersionUID from JDK 1.0.2 for interoperability */    private static final long serialVersionUID = -6849794470754667710L;
    /**     * Class String is special cased within the Serialization Stream Protocol.     *     * A String instance is written into an ObjectOutputStream according to     * <a href="{@docRoot}/../platform/serialization/spec/output.html">     * Object Serialization Specification, Section 6.2, "Stream Elements"</a>     */    private static final ObjectStreamField[] serialPersistentFields =        new ObjectStreamField[0];    ....}

public final class String {    ...    public char[] toCharArray() {        // Cannot use Arrays.copyOf because of class initialization order issues        char result[] = new char[value.length];        System.arraycopy(value, 0, result, 0, value.length);        return result;    }    ...}

typedef enum Status {    STATUS_OK = 0,    STATUS_UNKNOWN_TABLET                = 1,    STATUS_WRONG_VERSION                 = 2,    ...    STATUS_INDEX_DOESNT_EXIST            = 29,    STATUS_INVALID_PARAMETER             = 30,    STATUS_MAX_VALUE                     = 30,    // Note: if you add a new status value you must make the following    // additional updates:    // (1)  Modify STATUS_MAX_VALUE to have a value equal to the    //      largest defined status value, and make sure its definition    //      is the last one in the list. STATUS_MAX_VALUE is used    //      primarily for testing.    // (2)  Add new entries in the tables "messages" and "symbols" in    //      Status.cc.    // (3)  Add a new exception class to ClientException.h    // (4)  Add a new "case" to ClientException::throwException to map    //      from the status value to a status-specific ClientException    //      subclass.    // (5)  In the Java bindings, add a static class for the exception    //      to ClientException.java    // (6)  Add a case for the status of the exception to throw the    //      exception in ClientException.java    // (7)  Add the exception to the Status enum in Status.java, making    //      sure the status is in the correct position corresponding to    //      its status code.}

/*** * @param user* @param password* @return*/private boolean login(String user, String password) {    ...}

// Add a horizontal scroll barhScrollBar = new JScrollBar(JScrollBar.HORIZONTAL);add(hScrollBar, BorderLayout.SOUTH);// Add a vertical scroll barvScrollBar = new JScrollBar(JScrollBar.VERTICAL);add(vScrollBar, BorderLayout.EAST);// Initialize the caret-position related valuescaretX     = 0;caretY     = 0;caretMemX  = null;

/** * 用户登录 * @param user User对象 * @param password Password对象 * @return */private boolean login(User user, Password password) {    ...}

// Current offset in resp Bufferuint32_t offset;// Contains all line-widths inside the document and// number of appearances.private TreeMap<Integer, Integer> lineWidths;

//  Position in this buffer of the first object that hasn't//  been returned to the client.uint32_t offset;//  Holds statistics about line lengths of the form <length, count>//  where length is the number of characters in a line (including//  the newline), and count is the number of lines with//  exactly that many characters. If there are no lines with//  a particular length, then there is no entry for that length.private TreeMap<Integer, Integer> numLinesWithLength;

// If there is a LOADING readRpc using the same session// as PKHash pointed to by assignPos, and the last PKHash// in that readRPC is smaller than current assigning// PKHash, then we put assigning PKHash into that readRPC.int readActiveRpcId = RPC_ID_NOT_ASSIGNED;for (int i = 0; i < NUM_READ_RPC; i++) {    if (session == readRpc[i].session            && readRpc[i].status == LOADING            && readRpc[i].maxPos < assignPos            && readRpc[i].numHashes < MAX_PKHASHES_PERRPC) {        readActiveRpcId = i;        break;    }}

// Try to append the current key hash onto an existing// RPC to the desired server that hasn't been sent yet.int readActiveRpcId = RPC_ID_NOT_ASSIGNED;for (int i = 0; i < NUM_READ_RPC; i++) {    if (session == readRpc[i].session            && readRpc[i].status == LOADING            && readRpc[i].maxPos < assignPos            && readRpc[i].numHashes < MAX_PKHASHES_PERRPC) {        readActiveRpcId = i;        break;    }}

// If there is a LOADING readRpc using the same session// as PKHash pointed to by assignPos, and the last PKHash// in that readRPC is smaller than current assigning// PKHash, then we put assigning PKHash into that readRPC.

// Try to append the current key hash onto an existing// RPC to the desired server that hasn't been sent yet.