团队开发项目开发规范.docVIP

团队开发项目开发规范 概述 程序员一般需要团队合作，可能为了一个大型项目程序会有十人以上或者百人以上甚至千人以上的团队公司在一起工作。编码规范使程序规范化，易懂化，才能更好的进行合作。 编码规范第一、使代码更加易于维护，程序并不是一次性的产品，它需要扩展、修改以及维护的。但是进行这些操作的人并不一定就是同一个人，所以规范编码是非常重要的。 编码规范第二、可以提高代码质量，编程都不是一次性完成的，需要不断的测试与调试，以各种状态来修改代码，而将代码规范化，就能对程序本身有更加清晰的结构思路，从而减少调试而成为快捷高效的代码。 编码规范第三、团队化。 一开始就要养成良好的编码习惯，这样将为团队带来事半功倍的效果。 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： DateTime Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：dateTime 代码之美 编码是一件很有趣的事，如果发现代码的是一种美的语言的时候，编写代码再也不是枯燥的代名词。 列宽 代码列宽控制在110字符左右。 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 在逗号后换行； 在操作符前换行； 规则a优先于规则b。 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。 在代码中，不能包含多个空行。 在以下情况下使用一个空行： 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 7、注释与它注释的语句间不空行，但与其他的语句间空一行。 空格 在以下情况中要使用到空格： 关键字和左括符 “(” 应该用空格隔开。如while (true) 注意:在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。 2、多个参数用逗号隔开，每个逗号后都应加一个空格。 3、除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如 //字符测试0opxXnNjgasqwMm1lI a += c + d; a = (a + b) / (c * d); while (d++ = s++) { n++; } Response.Write (“size is “ + size); for (expr1; expr2; expr3) 括号 - () 1、 左括号“(” 不要紧靠关键字，中间用一个空格隔开。 2、 左括号“(” 与方法名之间不要添加任何空格。 3、 没有必要的话不要在返回语句中使用()。如 if (condition) Array.Remove(1) return 1 花括号 - {} 1、左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如 if (condition) { } public int Add(int x, int y) { } 2、左花括号 “{” 要与相应的右花括号 “}”对齐。 3、通常情况下左花括号 “{”单独成行，不与任何语句并列一行。 4、 if、while、doif (somevalue == 1) { somevalue = 2 } 5、右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如 while (condition) { if (condition) { } else { } // if } // while 代码注释 城 注释概述 1、修改代码时，总是使代码周围的注释保持最新。 、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍 3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。。尽管一般不应该为了使代码更简单