Nutz Java 编码规范 (V1.0)

Nutz Java 编码规范 (V1.0) By:zozoh 0. 规范的规范 1. 代码格式 2.1 包 2.2 类和接口 2.3 成员变量 2.4 常量 2.5 局部变量 2.6 成员函数和静态函数 3. 注释 3.1 类 Java Doc 3.2 函数 Java Doc 3.3 字段 Java Doc 3.4 函数内部注释 4. 编程 5. 单元测试 0. 规范的规范 本规范的每一条目必须无二义性，并且可执行。否则作废 本规范的条目分为两个级别: 规则 - R 建议 - S 本规范所有的“规则”条目必须被遵守 1. 代码格式 R-使用统一的 Eclipse 的代码格式: code.google.com/p/nutz/source/browse/trunk/doc/eclipse/nutz-eclipse-java-code-format-1.0.xml 请从 svn 的 trunk/doc/eclipse/nutz-eclipse-java-code-format-1.0.xml 获得此文件 S-非 Eclipse 用户请阅读上述 XML 代码自行遵守 基本上我们没有为非 Eclipse 用户指定规范，我们还没有一个好办法 2. 命名 2.1 包 R-包名必须全部小写，2个以内单词。 S-最好为 1 个单数名词 R-所有项目的包要以 “org.nutz” 为父 包 。 2.2 类和接口 S-最好为名词 R-命名类和接口时，需要将所有单词的首字母大写。 R-接口的命名不采用首字母为 I 或加上 IF 后缀的命名方式 。例 如 ：IBookDao 、 BookDaoIF 等 。 R-抽象类必须使用 Abstract 作为类名的前缀，而接口建议使用 Interface 作为 接口名后缀。 R-异常类应该使用 Exception 做为 名称 后缀。 R-如果是运行一次就抛弃的类，以 ing 结尾，比如Rendering R-类名尽量短，但是最好不要缩写，如果缩写，必须为特别常用的类，比如 org.nutz.dao.Cnd 因为调用者书写你的类名太长，他(她)的IDE会自动替他(她)换行，他会觉得有点不爽 R-不要和 Java 的标准库中的类名冲突，比如 Class, Object, String 等 如果冲突，就表示你极其藐视 Java 标准库中的那个的设计 调用者需要花更多的时间和代码来明确他使用的是你