诺恩开创开发规范.docVIP

北京诺恩开创 开发规范 作者： 2009年3月1日 目 录 第1章 前言 1-3 1.1 编写目的 1-3 1.2 项目背景 1-3 1.3 术语定义 1-3 第2章 系统整体架构 2-3 2.1 系统设计原则 2-3 2.1.1 系统实用性 2-3 2.1.2 系统可靠和稳定性 2-3 2.1.3 系统灵活性 2-4 2.2 系统设计框架 2-4 2.2.1 设计架构图 2-4  开发规范 前言 编写目的 本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 使用范围 本规范适用于诺恩公司所有软件项目、产品等的设计、开发以及维护、升级等。 本规范使用于诺恩公司所有软件开发人员，在整个软件开发过程中必须遵循此规范。 版本声明 参考资料 《Sun Java语言编码规范》(Java Code Conventions) 《Effictive Java》 《Java Pitfalls》 《Java Rules》 代码组织和风格 基本原则 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。 本章所涉及到的内容一般都可在Java集成编辑环境（myEclipes5.5以上）中进行相应设置，也可由Ant等调用checkstyle等来进行自动规整。 JavaScript 程序应独立保存在后缀名为 .js 的文件中JavaScript 代码不应该被包含在 文件中，除非这是段特定只属于此部分的代码。在 HTML 中的JavaScript代码会明显增加文件大小，而且也不能对其进行缓存和压缩。 当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。 代码（java、js）中以TAB（4个字符）缩进，在编辑器中请将TAB设置为以空格替代，否则在不同编辑器（myEclipes5.5以上）或设置下会导致TAB长度不等而影响整个程序代码的格式。例如： Table1．缩进示例 public void methodName(){ if(some condition){ for(…){ //some sentences }//end for }//end if } 长度 为便于阅读和理解，单个函数的有效代码长度当尽量控制在100行以内（不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。 单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。 尽量避免使用大类和长方法。 JavaScript 代码不应该被包含在 文件中，除非这是段特定只属于此部分的代码。80字符。一般不要超过这个宽度, 这会导致在某些机器中无法以一屏来完整显示, 但这一设置也可以灵活调整。在任何情况下, 超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后, 应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。 类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。 操作符两端应当各空一个字符以增加可读性。 括号 括号 {} 中的语句应该单独作为一行，左括号{当紧跟其语句后，右括号}永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块。 较长的方法以及类、接口等的右括号后应使用//end ...等标识其结束。如: 类的结束符：}//EOC ClassName， 方法结束符：}//end methodName()， 功能块结束：}//end if...userName is null? 循环快结束：}//end for...every user in userList 不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。 左括号是否换行等随个人习惯而定，若换行则当与其前导语句首字符对齐。 代码注释 注释基本原则 注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。 如果你的程序不值得注释，那么它很可能也不值得运行。 避免使用装饰性内容。 保持注释的简洁。 注释信息不仅要包括代码的功能，还应给出原因。 不要为注释而注释。 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。 JavaDoc 对类、方法、变量等的注释需要符合Ja