会飞的鱼 — Wed, 03 Jan 2007 11:22:00 GMT

SpringSide的代码规�?

前言

本文档反映的是SpringSide 团队的编码规范，同时推荐所有��用SpringSide框架的开发�h员遵循�?/p>

    本文档基本遵�?span class="nobr">Sun's Coding Conventions�Q�补充了其中没有说明或者有所改动的地斏V�?br />
    本文档随SpringSide的开发而不断更斎ͼ�最新版本请讉K��SpringSide Wiki�Q?/font>

    http://wiki.springside.org.cn/display/springside/Coding+Standards版权声明

本规范由springside团队�l�护�Q�相兌��Z��意见请发至springside@gmail.com�Q��{载请注明出处�?/p>

规范�{��说明

�U�别I: 默认登记要求所有项目中的所有成员遵守�?/font>

�U�别II: ��所有项目中的所有成员遵守�?/font>

�U�别III: �?/font> 励各个项目根据实际情冉|��行�?/font>

1.格式与命名规�?Formating and Naming Conventions)

1.1 �~�进

使用Tab�~�进�Q�而不是空格键--��羃�q?�Q?�Q?字符的选择权留�l�阅读者�?/p>

1.2 换行

每行120字符--因�ؓ已是1024*768的年代�?/p>

if,for,while语句只有单句�Ӟ��如果该句可能引�v阅读��h��Q�需要用" {"�?}"括�v来，否则可以省略�?/p>

// 错误�Q�需要��用花括号{}括�v�?/span>
if (condition)
if (condition) doSomething();
else
doSomething();

1.3 命名规则

不允�怋�用汉语拼韛_��名�?

遇到�~�写如XML�Ӟ��仅首字母大写�Q�即loadXmlDocument()而不是loadXMLDocument()

Package名必��d��部小写，��量使用单个单词

Interface名可以是一个名词或形容�?加上'able','ible', or 'er'后缀)�Q�如Runnable�Q�Accessible�?br />��Z��Z��接口�~�程�Q�不采用首字母�ؓI或加上IF后缀的命名方式，如IBookDao,BookDaoIF�?

��面部�g名徏议命名�ؓ�Q�btnOK、lblName或okBtn、nameLbl�?font color="#cc6600">(II)
其中btn、lbl�~�写代表按钮(Button)、标�{?Label)�?
局部变量及输入参数不要与类成员变量同名(get/set�Ҏ��与构造函数除�?

1.4 声明

修饰�W�应该按照如下顺序排列：public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp�?
�c�M��接口的声明顺�?可用Eclipse的source->sort members功能自动排列):
1. 静态成员变�?/ Static Fields
2. 静态初始化�?/ Static Initializers
3. 成员变量 / Fields
4. 初始化块 / Initializers
5. 构造器 / Constructors
6. 静态成员方�?/ Static Methods
7. 成员�Ҏ�� / Methods
8. 重蝲自Object的方法如toString(), hashCode() 和main�Ҏ��
9. �c�d��(内部�c? / Types(Inner Classes)

同等的类型，按public, protected, private的顺序排列�?/p>

2.注释规范(Document Convertions)

2.1 注释�c�d��

2.1.1 JavaDoc注释

略�?/p>

2.1.2 失效代码注释

�?*...*/界定�Q�标准的C-Style的注释。专用于注释已失效的代码�?/p>

/*
* Comment out the code
* String s = "hello";
* System.out.println(s);
*/

2.1.3 代码�l�节注释

�?/界定�Q�专用于注释代码�l�节�Q�即使有多行注释也仍然��?/�Q�以便与�?**/注释的失效代码分开

除了�U�有变量外，不推荐��用行末注释�?/p>

class MyClass {

     private int myField; // An end-line comment.

     public void myMethod {

        // a very very long
        // comment.
        if (condition1) {
           // condition1 comment
          ...
        } else {
           // elses condition comment
          ...
        }
    }
}

2.2 注释的格�?/h3>

注释中的�W�一个句子要以（英文�Q�句受��问��h��者感叹号�l�束。Javadoc生成工具会将注释中的�W�一个句子放在方法汇总表和烦引中�?

��Z��在JavaDoc和IDE中能快速链接蟩转到相关联的�c�M��Ҏ��Q�尽量多的��用@see xxx.MyClass�Q�@see xx.MyClass#find(String)�?

Class必须以@author 作者名声明作者，不需要声明@version与@date�Q�由版本��理�pȝ��保留此信息�?font color="#cc6600">(II)

如果注释中有��过一个段落，�?lt;p>分隔�?font color="#cc6600">(II)

�C�Z��代码�?lt;pre>包裹�?font color="#cc6600">(II)

标识(java keyword, class/method/field/argument名，Constants) �?lt;code>包裹�?font color="#cc6600">(II)

标识在第一�ơ出现时以{@linkxxx.Myclass}注解以便JavaDoc与IDE中可以链接�?font color="#cc6600">(II)

2.3 注释的内�?/h3>

2.3.1 可精��的注释内�?/h4>
注释中的每一个单词都要有其不可缺��的意义�Q�注释里不写"@param name -名字"�q�样的废话�?br /> 如果该注释是废话�Q�连同标�{�ֈ�掉它�Q�而不是自动生成一堆空的标�{�，如空的@param name�Q�空的@return�?/p>

2.3.2 推荐的注释内�?/h4>

对于API函数如果存在契约�Q�必��d��明它的前�|�条�?precondition)�Q�后�|�条�?postcondition)�Q�及不变�?invariant)�?font color="#cc6600">(II)

对于调用复杂的API��量提供代码�C�Z��?font color="#cc6600">(II)

对于已知的Bug需要声明�?font color="#cc6600">(II)

在本函数中抛出的unchecked exception��量用@throws说明�?font color="#cc6600">(II)

2.3.3 Null规约

如果�Ҏ��允许Null作�ؓ参数�Q�或者允许返回��gؓNull�Q�必��d��JavaDoc中说明�?br /> 如果没有说明�Q�方法的调用者不允许使用Null作�ؓ参数�Q��ƈ认�ؓ�q�回值是Null Safe的�?/p>

/**
* 获取对象.
*
* @ return the object to found or null if not found.
*/
Object get(Integer id){
...
}

2.3.4 �Ҏ��代码注释

代码质量不好但能正常�q�行�Q�或者还没有实现的代码用//TODO: �?//XXX:声明
存在错误隐患的代码用//FIXME:声明

3.�~�程规范(Programming Conventions)

3.1基本规范

当面对不可知的调用者时�Q�方法需要对输入参数�q�行校验�Q�如不符合抛出IllegalArgumentException�Q�徏议��用Spring的Assert�p�d��函数。�?
隐藏工具�cȝ��构造器�Q�确保只有static�Ҏ��和变量的�c�M��能被构�?
变量�Q�参数和�q�回值定义尽量基于接口而不是具体实现类�Q�如Map map = new HashMap();
代码中不能��用System.out.println()�Q�e.printStackTrace()�Q�必��M��用logger打印信息�?

3.2 异常处理

重新抛出的异常必��M��留原来的异常�Q�即throw new NewException("message",e); 而不能写成throw new NewException("message")�?
在所有异常被捕获且没有重新抛出的地方必须写日志。�?
如果属于正常异常的空异常处理块必��L��释说明原因，否则不允许空的catch块�?
框架��量捕获低��异常�Q��ƈ��装成高�U�异帔R��新抛出，隐藏低��异常的细节�?font color="#3333ff">(III)

3.3 代码度量

3.3.1 耦合度度�?/h4>

DAC度量��g��要不大于7 ( III )
解释�Q�DAC(Data Abstraction Coupling)数据抽象耦合度是描述对象之间的耦合度的一�U�代码度量。DAC度量��D��C�Z��个类中有实例化的其它�cȝ��个数�?

CFO度量��g��要不大于20 ( III )
解释�Q�CFO(Class Fan Out)�c�L��出是描述�c�M��间的耦合度的一�U�代码度量。CFO度量��D��C�Z��个类依赖的其他类的个数�?

3.3.2 �Ҏ��度量

�Ҏ��Q�构造器�Q�参数在5个以�?( II )
太多的方法（构造器�Q�参数媄响代码可��L��。考虑用值对象代替这些参数或重新设计�?

�Ҏ��长度150行以�?( II )

CC 度量��g��大于10(III )
解释�Q�CC(CyclomaticComplexity)圈复杂度指一个方法的独立路径的数量，可以用一个方法内if,while,do,for,catch,switch,case,?:语句�?amp;&,||操作�W�的��M��数来度量�?/font>

NPath度量��g��大于200 ( III )
解释�Q�NPath度量��D��C�Z��个方法内可能的执行�\径的条数。�?

3.3.3 其他度量

布尔表达式中的布��运��符(&&,||)的个��C��过3�?font color="#3333ff">(III)
if语句的嵌套层�?层以�?font color="#cc6600">(II)
文�g长度2000行以�?font color="#cc6600">(II)
匿名内部�c?0行以�?( II )
太长的匿名内部类影响代码可读�? ��重构为命名的�Q�普通）内部�c�R�?

3.4 JDK5.0

重蝲�Ҏ��必须使用@Override�Q�可避免父类�Ҏ��改变时导致重载函数失效�?
不需要关心的warning报告用@SuppressWarnings("unused"), @SuppressWarnings("unchecked"),@SuppressWarnings("serial") 注释�?

4.自动代码��?/h2>
   使用Eclipse�?�?Inellij IDEA 的代码校验已经可以排除很多问题�?/p>
   再配合��?span class="nobr">Checkstyle ，PMD ，FindBugs 三重检查，�׃��层的校验�늛�了大部分的Guide Line�?/p>
   如果代码要求不苛刻，可以仅��用Eclipse �?IDEA 搭配 Checkstyle的两重保湿效果�?/p>
Eclipse�Q�在Windows->Preferences->Java-Compiler->Errors/Warnings中，按本文档的规则将一些原来Ignore的规则打开�?
IDEA�Q�在Setting->Errors中设定规则，调用Analyzer->Inspece Code�q�行校验�?
CheckStyle�Q�安�?span class="nobr">CheckStyle的Eclipse插�g�Q�在Windows->Preferences->CheckStyle导入springside团队预设�?tools/codereviewer/springside_check.xml的规�?
PMD�Q�安�?span class="nobr">PMD的Eclipse插�g�Q�Windows->Preferences->PMD清除原来所有规则，导入springside团队预设�?tools/codereviewer/springside_pmd.xml的规则�?
FindBugs�Q�安�?span class="nobr">FindBugs的Eclipse插�g�Q�在��目属�?>FindBugs中，取消下列警告MS/EI/EI2/ �Q� SnVI/SE/WS/RS �Q�ST/NP/UwF/SS/UuF|UrF|SIC

5.参考资�?/h2>
Sun's Coding ConventionsSun MicroSystem�Q?
The Elements of Java Style Scott W. Ambler �{�著�Q?
代码��工��L��规则�Q?checkstyle�Q?span class="nobr">pmd �Q?span class="nobr">findbugs

会飞的鱼 2007-01-03 19:22 发表评论

久久久久亚洲AV无码专区首JN,亚洲精品国产电影,亚洲网红精品大秀在线观看