团队项目开发编码规范教案.ppt

｛｝ 团队项目开发编码规范之一：概述 为什么要制定编码规范： 第一、能代码更加易于维护，程序并不是一次性的产品，它需要扩展和修改还有维护的。但是进行这次操作的人并一定就是你了，所以你为了你的接班人也要将规范编码进行到底！ 第二、可以提高代码质量，谁编程都不是一次性完成的，是需要不断的测试与调试，以各种状态来修改自己的代码，而将代码规范化，就能对程序本身有更加清晰的结构思路，从而减少调试而成为快捷高效的代码。 第三、也是最为重要的，是将你本身个性化溶于团队化的过程，当你熟练运用编码规范了，就等于在以后的职场的道路上更加宽广。 编码规范是一种习惯，一开始习惯不养好，永远写不出工程型代码。 ｛｝ 团队项目开发“编码规范”之二：代码外观 1、列宽 代码列宽控制在110字符左右。 2、换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1）在逗号后换行; 2）在操作符前换行; 3）规则1优先于规则2。 3、缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 ｛｝ 团队项目开发“编码规范”之二：代码外观 4 、空行 空行是为了将逻辑上相关联的代码分块，以便提高代码可阅读性。 在代码中，不能包含多个空行。 在以下情况下使用一个空行 1）方法与方法、属性与属性之间。 2）方法中变量声明与语句之间。 3）方法与方法之间。 4）方法中不同的逻辑块之间。 　5）方法中的返回语句与其他的语句之间。 6）属性与方法、属性与字段、方法与字段之间。 7）注释与它注释的语句间不空行，但与其他的语句间空一行。 ｛｝ 团队项目开发“编码规范”之二：代码外观 5、 空格 在以下情况中要使用到空格 1）关键字和左括符 “(” 应该用空格隔开。如while (true) 注意:在方法名和左括符“(”之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。 2）多个参数用逗号隔开，每个逗号后都应加一个空格。 3） 除了 .之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如： a += c + d; a = (a + b) / (c * d); 4）语句中的表达式之间用空格隔开。如 for (expr1; expr2; expr3) ｛｝ 团队项目开发“编码规范”之二：代码外观 6、花括号 - {} 1）左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如 if (condition) { } 2）左花括号 “{” 要与相应的右花括号 “}”对齐。 3）通常情况左花括号 “{”单独成行，不与任何语句并列一行。 4） if、while、do语句后一定要使用{}，即使只有一条语句。如 if (somevalue == 1) { somevalue = 2; } ｛｝ 团队项目开发“编码规范”之二：代码外观 6、花括号 - {} 5）右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如 while (1) { if (valid) { } else { } // if } // while ｛｝ 团队项目开发“编码规范”之三：程序注释 1、注释概述 1）在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。 2） 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的。 3）避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。 4）在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工