开发规范

 

需求设计规范V1.0

 一．  模块与功能设计

 功能必须具备操作一致性，使用方式必须符合整个系统的模式以及非技术人员自然思维习惯。

 所有复杂的和需要使用者运算的功能，必须提供方便的页面内辅助帮助和辅助计算工具，并链接到wiki上提供详细的使用帮助。

 所有语言描述尽量非技术化，尽量避免技术术语的使用。

开发规范V1.0

一．  编码风格规范

  代码命名规范采用Sun命名规范。

  代码布局规范采用MyEclipse CodeStyle_CCTVStyle.xml定义【可以导入到MyEclipse中】。

  每个java类长度不得超过1000行；大型类需要备案。

二．  编程规范

  代码中禁止出现System.out/System.err调用

  代码中任何对HttpSession的引用和使用必须备案

  代码中关键位置需要书写完整的注释，包括：代码的作用，适用返回，特殊的输入和输出参数等。如果此处出现过bug，需要记录bug出现的原因以及修复办法。

  代码中关键位置和错误需要记录到log中，采用apache common logs进行日志记录。

  所有某些数据库专用的sql语句需要备案，并尽量避免。

  关键代码需要编写测试用例，测试采用JUnit。

三．  开发与测试环境

  平台框架开发尽量支持JDK1.4

  应用项目开发和运行环境采用JDK5/6

  JUnit测试数据库采用H2嵌入式数据库，测试用例完成后释放所有数据。

四．  代码管理

  代码服务器采用SVN。

  每天早上需要从SVN下载最新的代码，每天晚上下班前提交本地代码。

  提交到SVN的代码需要保证可以随时运行，有问题的代码不得提交。

五．  设计与资源限定

  数据库表每列总长度不得超过1024字节。

  超过1024字节的表，字段数不得超过5个。

  执行时长超过1秒的sql语句，每分钟不得多于1次执行。

  执行join查询的sql语句，每秒钟不得多于1次执行。

六．  其他