JR 共通类库编码规范

起草者：cherami
版本：1.0alpha
发布日期：2003.4.2

命名规则
- 包名：基本按照JDK的核心类库的结构组织，全部小写，必须以org.jr开始。
- 文件名/类名/接口名：按照java编码规范的要求是一个名词或者组合名词，大小写混合，单词的首字母大写，对于首字母大写的缩略语可以全部字母大写，名字要求简单并且具有描述性，尽量避免使用缩略语和缩写（除非是非常广泛使用的）。
- 方法名：按照java编码规范的要求应该是一个动词或者复合动词，除第一个单词外的首字母大写。
- 变量名：名词，首字母小写，其他的每个单词的首字母大写，不得以下划线或者美元符开头，具有描述性和助记性（便于记忆和描述其作用）。
- 常量：名词，全部字母大写，单词间以下划线分隔，具有描述性和助记性（便于记忆和描述其作用）。
缩进及tab键的使用：使用两个半角空格作为缩进，不得使用tab键作为缩进。
行长度：一般不得超过80个字符，包括缩进。
javadoc注释（每个public类必须有）。
- 版权信息：
```
/**
 * Copyright: Copyright (c) 2002-2003
 * Company: JavaResearch(http://www.javaresearch.org)
 * 最后更新日期:2003年3月28日
 * @author Cherami
 */
						  
```
  需要修改其中的更新日期和作者信息，如果有多个作者则按照贡献大小依次排列。此信息应该位于package语句之前或者package语句和import语句之间。
- 类/接口注释：简单说明一下类的作用，有些特殊的内容可以详细说明，必须包含since信息指明类引入到类库中的版本。
- 方法注释：对于所有的public/protected方法都需要完整的javadoc注释，如果方法引入的版本和类引入的版本不同则必须包含since信息指明类引入到类库中的版本，如果是接口中的方法则不必，因为理论上讲接口是不应该增加方法的；对于private方法，不需要since信息。
- 变量注释：要求同方法注释。
- 行注释：要求在语句的前面或者语句所在的行。