编程规范

打包命名：nutz[.模块名]-主版本号.质量级别.[发布序号].jar
1.模块名 : 可选，如不声明，则表示包括所有功能
2.主版本号 : 从 1 开始顺序递增，除非程序结构或者接口发生重大改动，否则保持不变
3.质量级别 : a 表示 alpha 品质， b 表示 beta 品质， r 表示 release 品质
a alpha: 表示这个版本，接口仍然不稳定，每次发布仍然有可能做微小的调整
b beta: 表示这个版本，接口已经稳定，主版号一致的 Beta 版会一直向前兼容，直至遇到一个 alpha 版
r release: 表示这个版本是一个非常稳定的版本。
4.发布序号 : 从 1 开始顺序递增

这就意味着，如果是如下的一系列版本
1.b.30 -> 1.a.31 -> 1.b.32 -> 1.b.33 -> 1.b.34
1.b.32 可能不会兼容 1.b.30
1.b.34, 可以兼容 1.b.33 和 1.b.32

命名规范 http://www.nutzam.com/core/committer/coding.html 【包】
R-包名必须全部小写，2个以内单词。
S-最好为 1 个单数名词
R-所有项目的包要以 “org.nutz” 为父 包。

【类和接口】名词
抽象类 Abstract 作为类名的前缀
接口 Interface 作为接口名后缀
缺省接口实现应该使用 Default 名称前缀，实现者用Impl作为后缀
异常类 Exception 做为 名称 后缀
运行一次就抛弃的类，以 ing 结尾

【成员变量】单数名词
能 private 就不要 default，能 default 就不要 protected，最好不要 public
如果是集合或数组，用复数名词

【常量】
命名常量（带有 final 修饰符的域）时需分隔。如 ： public final int MAX_VALUE = 30。

【局部变量】
局域变量名要尽量短，推荐用缩写

【成员函数和静态函数】
除了 setter / getter，其他的函数采用动词或者动名短语

注释
R-注释必须和代码保持同步 。
R-注释中的第一个句子要以（英文）句号、问号或者感叹号结束。 Java成工具会将注释中的第一个句子放在方法汇 总表和索引中。
R-如果注释中有超过一个段落，用 <P> 标签 分隔。
R-如果注释中有多个章节，用 <H2> 标签声明每个章节的标题。
R-如果注释需要换行，用 <BR> 标签。
R-示例代码以 <PRE></PRE> 包裹。

【类 Java Doc】
要著名作者，格式为 @Author XiaoMing(xm@gmail.com)
继承的方法可以省略注释，但是被继承方法必须有注释。

【函数 Java Doc】
R-简单的 get/set 方法可以省略注释。
R-继承的方法可以省略注释，但是被继承方法必须有注释。

【字段 Java Doc】

【函数内部注释】
R-行注释和块注释都是可以被接受的
R-不要写 JAVA DOC，没意义
R-代码质量不好但能正常运行，或者还没有实现的代码用 “ //TODO: ”
R-在 if ... else .. 分支上做注释格式应该 写在块内

【牢记】
“接口”固定了架构，“类” 不是
先让代码能工作，然后重构成为优美的代码
删掉一段代码的贡献，比增加一段代码的贡献要大
“逻辑”短，而不是“字符长度”短