Java编程规范-优快云博客

Genaral Principles一般约定

1.Adhere to the style of the original.
保持最初的样式。

2.Adhere to the Principle of Least Astonishment.
遵守最小惊奇原则。

3.Do it right the first time.
第一次就应当做好。

4.Document any deviations.
对于任何背离都应当文档注释。

Formatting Conventions格式约定

5.Indent nested code.
约束嵌套代码。

6.Break up long lines.
拆分长行。

7.Include white space.
包含空格。

8.Do not use "hard" tabs.
不要使用tab键。

Naming Conventions命名约定

9.Use meaningful names.
使用有意义的名称。

10.Use familiar names.
使用熟悉的名称。

11.Question excessively long names.
不要使用过长的名称。

12.Join the vowel generation.
加入元音字母。

13.Capitalize only the first letter in acronyms.
只对简称的第一个字母大写。

14.Do not use names that differ only in case.
不要使用只依赖于大小写来区分的名称。

PackageNames包命名

15.Use the reversed, lowercaseform of your organization's Internet domain name as the rootqualifier for your package names. 采用你组织的Internet域名的反转、小写形式作为包名称的根限定词。 16.Use a single, lowercase wordas the root name of each package. 使用一个唯一的小写单词作为每个包的根名称。 17.Use the same name for a newversion of a package, but only if that new version is still binarycompatible with the previous versin, otherwise, use a newname. 只有当包的新版本仍然与旧版本兼容时，对于包的新版本使用相同的名称，否则使用新名称。 Type Names类型命名 18.Capitalize the first letterof each word that appears in a class or interface name. 对于类和接口名称只对每个单词的第一个字母大写。 ClassNames类命名 19.Use nouns when namingclasses. 使用名词来命名类。 20.Pluralize the names ofclasses that group related attributes, static services, orconstants. 对于成组的相关属性、静态服务和常量，类名称采用复数形式。 Interface Names 接口命名 21.Use nouns or adjectiveswhen naming interfaces. 使用名词或形容词来命名接口。 MethodNames方法命名 22.Use lowercase for the firstword and capitalize only the first letter of each subsequent wordthat appears in a method name.] 方法名称中第一个单词小写，后续的每一个单词仅第一个字母大写。 23.Use verbs when namingmethods. 使用动词来命名方法。 24.Follow the JavaBeansconventions for naming property accessor methods. 命名属性访问方法遵守JavaBeans约定。 Variable Names变量命名 25.Use lowercase for the firstword and capitalize only the first letter of each subsequent wordthat appears in a variable name. 变量名称中第一个单词小写，后续的每一个单词仅第一个字母大写。 26.Use nouns to namefields. 使用名词来命名成员变量。 27.Pluralize the names ofcollection reference. 对于集合引用的名称采用复数形式。 28.Establish and use a set ofstandard names for trivial "throwaway" variables. 对于通常的临时变量，建立并使用一套标准名称。 FieldNames 成员命名 29.Qualify field variableswith "this" to distinguish them from local variables. 使用"this"限定成员变量以同局部变量区分。 Parameter Names参数命名 30.When a constructor or "set"method assigns a parameter to a field, give that parameter the samename as the field. 当构造函数或者"set"方法向成员分配参数时，参数的命名应和成员相同。 Constant Names常量命名 31.Use uppercase letters foreach word and separate each pair of words with an underscore whennaming constants. 当命名常量时，每个单词均大写，单词之间以下划线区分。 Documentation Conventions文档约定 32.Write documentation for those who must use your code and thosemust maintain it. 为那些使用你代码和维护它的人写文档。 33.Keep comments and code in sync. 保持注释与代码同步。 34.Use the active voice and omit needless words. 使用积极的语气，忽略无用的单词。 Comment Types注释类型 35.Use documentation commentsto describe the programing interface. 使用文档注释来描述程序接口。 36.Use standard comments tohide code without removing it. 使用标准注释来隐藏代码而不是删除。 37.Use one-line comments toexplain implementation details. 使用单行注释来解释实现细节。 Documentation Comments文档注释 38.Describe the programinginterface before you write the code. 在写代码之前描述程序接口。 39.Document public, protected,package, and private members. 对public、protected、package和private成员进行文档注释。 40.Provide a summarydescription and overview for each package. 对每一个包提供概述。 41.Provide a summarydescription and overview for each application or group ofpackages. 对每一个应用或者包的组提供概述。 CommentStyle 注释样式 42.Use a single consistentformat and organization for all documentation comments. 对于所有的文档注释坚持使用一种格式。 43.Wrap keywords, identifiers,and constants with<code>...</code>tags. 使用<code>...</code>标记包装关键字、识别符和常量。 44.Wrap code with<pre>...</pre>tags. 使用<pre>...</pre>标记包装代码。 45.Consider marking the firstoccurrence of an identifier with a {@link} tag. 考虑在标识符第一次出现时使用{@link}标记。 46.Establish and use a fixedordering for Javadoc tags. 对于Javadoc标记应该建立并使用一种固定的顺序。 47.Write in the third-personnarrative form. 以第三人称的叙述形式写。 48.Write summary descriptionsthat stand alone. 写概述应该独立。 49.Omit the subject in summarydescriptions of actions or services. 在概述中忽略目标。 50.Omit the subject and theverb in summary descriptions of things. 在事物的概述中忽略目标和动词。 51.Use "this" rather than"the" when referring to instance of current class. 当指代当前类的实例时，用"this"而不是"the"。 52.Do not add parentheses to amethod or constructor name unless you want to specify a particularsignature. 不要对方法或构造函数名增加括号，除非你想表示特定的签名。 Comment Content 注释内容 53.Provide a summarydescription for each method. 给每一个方法提供概述。 54.Fully describe thesignature of each method. 完整描述每一方法签名。 55.Include examples. 包含示例。 56.Document preconditions,postconditions, and invariant conditions. 对前置、后置、不变条件进行文档注释。 57.Document known defects anddeficiencies. 对已知的缺陷和不足进行文档注释。 58.Document synchronizationsemantics. 对同步语法进行文档注释。 Internal Comments内部注释 59.Add internal comments onlyif they will aid others in understanding your code. 只有当内部注释有助于其他人理解你的代码时才添加。 60.Describe why the code isdoing what it does, not what the code is doing. 描述代码为什么那样做，而不是做了什么。 61.Avoid the use of end-linecomments. 避免使用行尾注释。 62.Explain local variabledeclarations with an end-line comment. 使用行尾注释解释局部变量声明。 63.Establish and use a set ofkeywords to flag unresolved issues. 建立并使用一套关键字来标记未确定的情况。

eclipse约定