1 / 8
文档名称:

编码规范.doc

格式:doc   大小:50KB   页数:8页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

编码规范.doc

上传人:小点 2019/4/17 文件大小:50 KB

下载得到文件列表

编码规范.doc

相关文档

文档介绍

文档介绍:(FormatingandNamingConventions)最重要:不用死记硬背,直接使用Eclipse的自动格式化功能。换行:每行120字符以上--因为现在屏幕已大为宽广。括号:if,for,while语句全部使用括号包围。命名规则:不允许使用汉语拼音命名避免使用下划线(静态变量除外) 接口尽量采用"able","ible",or"er",如Runnable命名,尽量不采用首字母为I或加上IF后缀的命名方式,如IBookDao,BookDaoIF。(II)(DocumentConvertions)/***....**/失效代码注释由/**...**/界定,标准的C-Style的注释。专用于注释已失效的代码。代码细节注释由//界定,专用于注释代码细节。注意:即使有多行注释也仍然使用//,以便与用/**/注释的失效代码分开。(英文)句号、问号或者感叹号结束。Javadoc生成工具会将注释中的第一个句子放在方法汇总表和索引中。为了在JavaDoc和IDE中能快速链接跳转到相关联的类与方法,尽量多的使用***@,***@#find(String)。Class必须以***@author声明作者,体现代码责任。但不需要声明***@version与***@date,由版本管理系统保留此信息。(II)标识(javakeyword,class/method/field/argument名,Constants)在注释中第一次出现时以{***@}注解以便JavaDoc与IDE中可以链接。(II),注释里不写"***@paramname-名字"这样的废话。如果该注释是废话,连同标签删掉它,而不是自动生成一堆空的标签,如空的***@paramname,空的***@return。推荐的注释内容对于调用复杂的API尽量提供代码示例。(II)对于已知的Bug需要声明,//TODO或//FIXME声明:未做/有Bug的代码。(II)Null规约:  如果方法允许Null作为参数,或者允许返回值为Null,必须在JavaDoc中说明。否则方法的调用者不允许使用Null作为参数,并认为返回值是NullSafe(不会返回NULL)。(ProgrammingConventions),方法需要对输入参数进行校验,如不符合则抛出IllegalArgumentException,建议使用Spring的Assert系列函数。因为,()仅把信息显示在控制台,因此不允许使用,必须使用logger打印并记录信息。在数组中的元素(如String[1]),如果不再使用需要设为NULL,否则会内存泄漏。因此直接用Collections类而不要使用数组。在不需要封闭修改的时候,尽量使用protected而不是private,方便子类重载。变量,参数和返回值定义尽量基于接口而不是具体实现类,如Mapmap=newHashMap();用double而不是Float,因为float会容易出现小数点后N位的误差。