2008-06-25

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

关键字: 规范
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 一下自己的代码，不允许把不应该提交的内容提交到版本控制系统中
评论
jiming 2008-06-27
6. 一定要有分模块和重用的思想，包括但不限于 java、jsp、js、css、html 等。
优点包括：
a) 重用
b) 易于维护
c) 结构清晰
缺点：
a) 最初开发工作量有所增加
b) 要求开发人员进行比较深入的思考，要有重构的激情
原则：
a) 尽量的细分，考虑到通用级别、模块级别、子模块级别
b) 参见原则 1
发表评论

您还没有登录，请登录后发表评论

jiming
搜索本博客
最近加入圈子
存档
最新评论