Sun 公司代码规范.doc

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. 不要使用只依赖于大小写来区分的名称。 Package Names??包命名 ??15.Use the reversed, lowercase form of your organizations Internet domain name as the root qualifier for your package names. ??采用你组织的Internet域名的反转、小写形式作为包名称的根限定词。 ??16.Use a single, lowercase word as the root name of each package. ??使用一个唯一的小写单词作为每个包的根名称。 ??17.Use the same name for a new version of a package, but only if that new version is still binary compatible with the previous versin, otherwise, use a new name. ??只有当包的新版本仍然与旧版本兼容时，对于包的新版本使用相同的名称，否则使用新名称。?? Type Names 类型命名 ??18.Capitalize the first letter of each word that appears in a class or interface name. ??对于类和接口名称只对每个单词的第一个字母大写。 ??Class Names??类命名 ?? 19.Use nouns when naming classes. ?? 使用名词来命名类。 ?? ?? 20.Pluralize the names of classes that group related attributes, static services, or constants. ?? 对于成组的相关属性、静态服务和常量，类名称采用复数形式。?? ??Interface Names 接口命名 ?? 21.Use nouns or adjectives when naming interfaces. ?? 使用名词或形容词来命名接口。 Method Names??方法命名 ??22.Use lowercase for the first word and capitalize only the first letter of each subsequent word that appears in a method name.] ??方法名称中第一个单词小写，后续的每一个单词仅第一个字母大写。 ??23.Use verbs when naming methods. ??使用动词来命名方法。 ??24.Follow the JavaBeans conventions for naming property accessor methods. ??命名属性访问方法遵守JavaBeans约定。 Variable Names 变量命名?? ??25.Use lowercase for the first word and capitalize only the