华为JAVA编程规范(8)

建议7 使用Html标签使JavaDoc生成更加美观。(1.42+)

示例：

/**

* Returns a hash code for this string. The hash code for a * <code>String</code> object is computed as * <blockquote><pre>

* s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1] * </pre></blockquote>

* using <code>int</code> arithmetic, where <code>s[i]</code> is the * <i>i</i>th character of the string, <code>n</code> is the length

* of

* the string, and <code>^</code> indicates exponentiation. * (The hash value of the empty string is zero.) *

* @return a hash code value for this object. */

public int hashCode() 生成后的

JavaDoc

图1 生成后的JavaDoc

1.3 命名 1.3.1 规则

规则1 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使

用小写的大小写混合法。(1.42+)

示例：OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction

规则2 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写

其余字母小写的大小写混合法。(1.42+)

示例：

private void calculateRate();

public void addNewOrder();

规则3 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。

(1.42+)

Page 8 , Total 19