写代码的简要规范（必须要遵守）

1. 每个函数的行数不得超过 显示器的一屏幕的高度，如果有这样的情况的话就应该分成多个函数
2. 要注意多使用 namespace 的方式，尤其是 javascript 代码，以避免变量名冲突
   比如：g_aaa, g_module1_aaa, c_max_name_len, c_module1_max_name_len ....
3. 注释，一定要加，要按照 javadoc 的标准格式，不要自己随意定制格式
4. 因为已经有了版本控制系统，所以提交时要把注释的老的代码删除掉，以避免代码混乱难于维护
5. java 代码中不允许出现 magic number, 需要的地方要定义常量
7. 提交代码前一定要自己 review 一下自己的代码，不允许把不应该提交的内容提交到版本控制系统中
8. 编辑过 Base*.java 后应该给该代码添加 MANUAL_EDITED 字符标识
   Pojo.xml/Pojo_2.xml/Pojo_3.xml 也同样
   * 所有的修改过的代码都添加改标识

评论

4 楼 jiming 2009-03-05  

参考一下别人的规范


写程序需要注意的一些细节
是否符合代码格式化标准
是否有多余的import项
是否定义了多余的field
是否定义了多余的本地变量
是否定义了多余的私有方法
是否有可以重构的逻辑重复的代码
方法／成员的public/private/static/final属性是否合理
调用静态常量是否使用类／接口名
是否所有实现了java.io.Serializable接口的类都有serialVersionUID
类／接口／变量／参数名，命名是否规范
所有的if,for,while块内容是否都用{}
是否有功能复杂的语句
将url，文件路径等写死在程序里（硬编码）
将中文写在程序里
系统中使用到的非描述性字符串是否使用常量
系统中使用到的数字是否使用常量
常量是否有详细的注释
程序中是否存在System.out,System.err及Throwable.printStackTrace()
系统中打开的流／文件／连接等是否保证能正常并及时关闭
在输出日志时，低级别的输出一定要判断isXXEnabled
在生产环境中输出大量调试日志
注意使用对象的线程安全
大规模的string组装
递归方法的使用－－－尽量避免
本地线程对象是否导致memory leak
应用代码中严格禁止硬转 编码，只能在框架里做统一的处理
是否编译过正则表达式,是否有大规模的表达式
在出错路径上是否所有的资源（数据库连接，文件锁等）和引用都已经释放
在保证线程安全的同时，要注意避免过度使用同步，导致性能降低
同步对象上的锁是否按相同的顺序获得和释放以避免死锁，注意错误处理代码
所有的循环是否优化
如果调用了阻塞方法，是否考虑了保证性能的措施
方法（函数）方面检查安全

3 楼 jiming 2009-02-11  

修改了数据库结构，以后一定要群发给所有的人，通知大家修改自己的对应开发数据库。

2 楼 jiming 2008-12-03  

7. 所有的返回 collection, map, array 的函数都必须返回一个非空对象，不允许返回 null (试行)

1 楼 jiming 2008-06-27  

6. 一定要有分模块和重用的思想，包括但不限于 java、jsp、js、css、html 等。
   优点包括：
   a) 重用
   b) 易于维护
   c) 结构清晰
   缺点：
   a) 最初开发工作量有所增加
   b) 要求开发人员进行比较深入的思考，要有重构的激情
   原则：
   a) 尽量的细分，考虑到通用级别、模块级别、子模块级别
   b) 参见原则 1