代码管理及规范.pdf

开发文档系列 代码管理及规范 【网络公开版】 Solvay 2015 年8 月11 日 1 开发文档系列 目录 1.引序3 2. 目的5 3.适用范围6 4.svn 规范及要求6 4.1 SVN 操作流程6 4.2 账号6 4.3 检出代码7 4.4 提交代码7 4.5 标注要求8 4.6 慎用锁定功能9 4.7 传统备份9 4.8 创建个人文件夹9 5.代码规范要求9 5.1 项目层次结构规范9 5.2 页面规范 10 5.3 样式规范 10 5.4 JavaScript 代码规范 11 5.5 类规范 11 5.6 注释规范 12 5.7 SQL 语名规范 13 5.8 排版 14 5.8.1 缩进 14 5.8.2 空行 14 6 开发环境及辅助工具 14 6.1 jdk 版本 14 6.2 环境变量 15 6.3 开发使用IDE 15 6.4 运行容器 17 6.5 其它工具 18 6.6 终端环境兼容 18 7 写在结尾 19 2 开发文档系列 1.引序 开始前，举一个故事作为引子，使阅读者从客观上有个大概的了 解。未必能准确客观反应，还请谅解。 三国刘备一次攻击曹军计划，诸葛亮 【架构师】制定作战方案： 刘备 【独裁者】率少量人马引曹军深入埋伏； 张飞 【程序猿A】刺探前方军情； 关羽【程序猿B】负责正面交战，拼杀一阵则撤退； 赵子龙 【程序猿C】则围堵、追杀逃兵。 作战时，发生如下情况，张飞性格粗暴，在刺探军情时顺手斩了 几个曹军士兵，惊动了曹军。刘备则想，我一国之君，诸葛小儿狂妄 自大，竟令我去诱敌。而且风险很大，则私下交待赵子龙保护其安全。 关羽在正面交战时，因为前面惊动了曹军，导致曹军有备而来，虽尽 力但没及时撤退，待伤亡很严重时被迫逃窜。此时赵子龙却护送着刘 备，围堵、追杀方案根本无法实施。 通过上述例子，能反应出如下： ? 张飞多写了不属于自己的代码，造成相关功能重复执行， 轻者影响系统运行效率真，严重则造成不可逆错误； ? 刘备没遵循代码管理及版本控制要求，私改方案，并且没 有与诸葛亮重新商讨、修改，而造成整体方案在前期就预 示夭折的结果； 3 开发文档系列 ? 关羽虽按方案痛苦的写着代码，但因其他成员的失误而举 步维艰，在发现情况不对时，未采取补救措施； ? 赵子龙则追随刘备，参与了刘备私改方案的编码，造成与 整个方案的脱离。 最后结果可想而知，刘备军队大败。 通过上面的故