团队项目开发编码规范.docx
《团队项目开发编码规范.docx》由会员分享，可在线阅读，更多相关《团队项目开发编码规范.docx（79页珍藏版）》请在冰豆网上搜索。
团队项目开发编码规范
团队项目开发"编码规范"之一：
概述
“程序员、程序员”顾名思义就是来编程序的人员。
他们和一般工作人员是一样的，都需要合作，可能为了一个大型项目程序会有十人以上或者百人以上甚至千人以上的团队公司在一起工作。
编码规范使程序规范化，易懂化，才能更好的进行合作。
开发程序的软件很多。
但是它们的检查方式全是检查语法，并没有规定变量命名以及方法的命名，所以注释是很必要的东西，不过如果你将变量命名的规范一些。
Java和C#里的命名是最接近自然语言的缺点是名字太长，你不喜欢你的老板，但是你得从老板手里赚钱，这就是道理。
喜欢是一回事，赚钱是另外一回事，找既喜欢，又赚钱的事情做，太难了。
命名其实是越长越好的，因为表意性很好，大家看了像看文章一样，一目了然。
这样才会使得别人更加明白清晰的看清你写程序的思路。
很多人忌讳写长名字，主要原因，可能还是怕敲起来麻烦。
现在我们在学校用的visualstudio2005其实有很方便的拷贝功能，事实上，我的变量名，函数名，都只敲一遍，以后全部是拷贝+粘贴。
这样还有一个好处，就是我写的代码，永远不会有笔误，不会因为我敲错一个字符而导致bug。
用一个好的习惯，解决整整一个方面的bug，你说划算不划算？
如果你对英语并不是特别熟悉，你可以去看看金山词霸，在里面又背英语又进行编码规范的训练挺好。
再说你选择了程序员这条路，英语简直是关键中的关键。
编码规范第一、能使你的代码更加易于维护，程序并不是一次性的产品，它需要扩展和修改还有维护的。
但是进行这次操作的人并一定就是你了，所以你为了你的接班人也要将规范编码进行到底！
编码规范第二、可以提高代码质量，谁编程都不是一次性完成的，是需要不断的测试与调试，以各种状态来修改自己的代码，而将代码规范化，就能对程序本身有更加清晰的结构思路，从而减少调试而成为快捷高效的代码。
编码规范第三、也是最为重要的是将你本身个性化溶于团队化的过程，当你熟练运用编码规范了，就等于在以后的职场的道路上更加宽广。
编码规范是一种习惯，所以一开始习惯不养好，永远写不出工程型代码。
1.1术语定义
1.1.1Pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
例如：
BackColor
团队项目开发"编码规范"之二：
代码外观
2.1列宽
代码列宽控制在110字符左右。
2.2换行
当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
1、在逗号后换行;
2、在操作符前换行;
3、规则1优先于规则2。
2.3缩进
缩进应该是每行一个Tab（4个空格），不要在代码中使用Tab字符。
2.4空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
在代码中，不能包含多个空行。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行，但与其他的语句间空一行。
2.5空格
在以下情况中要使用到空格
1、关键字和左括符“（”应该用空格隔开。
如while（true）
注意:
在方法名和左括符“（”之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。
2、多个参数用逗号隔开，每个逗号后都应加一个空格。
3、除了.之外，所有的二元操作符都应用空格与它们的操作数隔开。
一元操作符、++及--与操作数间不需要空格。
如
a+=c+d;
a=（a+b）/（c*d）;
while（d++=s++）
{
n++;
}
PrintSize（“sizeis“+size+“\n”）;
4、语句中的表达式之间用空格隔开。
如
for（expr1;expr2;expr3）
2.6括号-（）
1、左括号“（”不要紧靠关键字，中间用一个空格隔开。
2、左括号“（”与方法名之间不要添加任何空格。
3、没有必要的话不要在返回语句中使用（）。
如
if（condition）
Array.Remove
（1）
return1
2.7花括号-{}
1、左花括号“{”放于关键字或方法名的下一行并与之对齐。
如
if（condition）
{
}
publicintAdd（intx,inty）
{
}
2、左花括号“{”要与相应的右花括号“}”对齐。
3、通常情况下左花括号“{”单独成行，不与任何语句并列一行。
4、if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。
如
if（somevalue==1）
{
somevalue=2;
}
5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。
如
while
（1）
{
if（valid）
{
}
else
{
}//if
}//while
团队项目开发"编码规范"之三：
程序注释
3.1注释概述
1、修改代码时，总是使代码周围的注释保持最新。
2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。
注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。
不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。
4、避免杂乱的注释，如一整行星号。
而是应该使用空白将注释同代码分开。
5、避免在块注释的周围加上印刷框。
这样看起来可能很漂亮，但是难于维护。
6、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
7、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。
尽一切可能不注释难以理解的代码，而应该重写它。
尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
8、在编写注释时使用完整的句子。
注释应该阐明代码，而不应该增加多义性。
9、在编写代码时就注释，因为以后很可能没有时间这样做。
另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
10、避免多余的或不适当的注释，如幽默的不主要的备注。
11、使用注释来解释代码的意图。
它们不应作为代码的联机翻译。
12、注释代码中不十分明显的任何内容。
13、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。
14、对由循环和逻辑分支组成的代码使用注释。
这些是帮助源代码读者的主要方面。
15、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。
16、用空白将注释同注释分隔符分开。
在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。
17、在所有的代码修改处加上修改标识的注释。
18、为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。
namespaceLangchao.Procument.Web
{
}//namespaceLangchao.Procument.Web
3.2文件注释
在每个文件头必须包含以下注释说明
//
//Copyright（c）HP.Allrightsreserved.
//
//×××
//yyyy-mm-dd
//文件功能描述
//
//修改人：
×××
//修改时间：
yyyy-mm-dd
//修改描述：
×××
//版本：
1.0
//
注意：
文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名。
如：
Zhangsan。
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
3.3文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。
如
1、类、接口注释
///
///类功能的说明
///
///
///
///创建人：
Zhangsan
///创建日期：
yyyy-mm-dd
///修改人：
Lisi
///修改日期：
yyyy-mm-dd
///修改备注：
无
///版本：
1.0
///
publicclassCountersModuleInitializer:
ModuleInitializer
{
}
注意：
标签根据具体情况选择有无
2、方法、事件注释
///
///根据员工编号获得员工信息
///
///员工编号
///系统异常
///员工姓名
///
///创建人：
Zhangsan
///创建日期：
yyyy-mm-dd
///修改人：
Lisi
///修改日期：
yyyy-mm-dd
///修改备注：
无
///版本：
1.1
///
publicstringGetEmployeeNameById（intemployeeId）
{
try
{
return"ddd";
}
catch（System.Exception）
{
throw;
}
}
注意：
该方法注释中的、、等标签根据具体情况选择有无，方法初始版本为1.0，每次改动增加0.1。
3、属性、常量注释
///
///sessionid
///
publicconststringSESSION_ID="";
3.3单行注释
该类注释用于
1方法内的代码注释。
如变量的声明、代码或代码段的解释。
注释示例：
//注释语句
privateintnumber;
2方法内变量的声明或花括号后的注释,注释示例：
if（1==1）//alwaystrue
{
statement;
}
else//alwaysfalse
{
}
3.4JavaScript注释
a）注释符号
‘//’
不允许使用‘/**/’作注释符。
b）函数注释
每个函数都应该描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。
格式如下：
//
//Function:
函数名
//Purpose:
用途
//Scope:
作用范围
//Args:
入口参数（列表）类型传值方式含义
//Returns:
返回值类型（可确定值列表）含义
//
c）非函数注释
注明该模块的作用
格式如下：
//
//功能：
//
d）程序行间注释
在程序行的每一个处理单元前作注释
格式如下：
//注释
e）注释举例
//
//Function:
F_FindObject
//Purpose:
按照空间名在可视化主对象中查找住对象内的可视化控件
//Scope:
Public
//Args:
is_nameStringvalue：
要查找的空间名
//ipbo_objectObjectvalue:
可视化主对象
//Returns:
BooleanTrue表示找到该控件
//False表示没有找到该控件
//
functionF_FindObject（is_name,ipbo_object）{
//获得显示学生信息的GreeView控件
vargv_student=document.getElementById（"GVStudent"）;
***********
//返回true
returntrue;
}
3.5注释标签
标签
用法
作用
c>text
text希望将其指示为代码的文本。
为您提供了一种将说明中的文本标记为代码的方法。
使用将多行指示为代码
content
content段落文本。
用于诸如或等标记内，使您得以将结构添加到文本中。
description
name为方法参数名。
将此名称用单引号括起来（''）。
应当用于方法声明的注释中，以描述方法的一个参数。
name
要引用的参数名。
将此名称用双引号括起来（""）。
标记为您提供了一种指示词为参数的方法。
可以处理XML文件，从而用某种独特的方法格式化该参数。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member传递给输出XML中的元素名。
必须将member括在双引号（""）中。
使您得以从文本内指定链接。
使用指示希望在“请参阅”一节中出现的文本。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member传递给输出XML中的元素名。
必须将member括在双引号（""）中
使您得以指定希望在“请参阅”一节中出现的文本。
使用从文本
description
description
代码示例的说明。
使用标记可以指定使用方法或其他库成员的示例。
一般情况下，这将涉及到标记的使用。
content
content为希望将其标记为代码的文本。
记为您提供了一种将多行指示为代码的方法。
使用指示应将说明中的文本标记为代码
description
此处description为对象的摘要。
应当用于描述类型成员。
使用以提供有关类型本身的信息。
description
cref="member"对可从当前编译环境中获取的异常的引用。
编译器检查到给定异常存在后，将member转换为输出XML中的规范化元素名。
必须将member括在双引号（""）中。
description说明。
标记使您可以指定类能够引发的异常。
filename包含文档的文件名。
该文件名可用路径加以限定。
将filename括在单引号中（''）。
Tagpath：
filename中指向标记名的标记路径。
将此路径括在单引号中（''）。
name注释前边的标记中的名称说明符；名称具有一个id。
id
位于注释之前的标记的id。
将此id括在双引号中（""）。
标记使您得以引用描述源代码中类型和成员的另一文件中的注释。
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
标记使用XMLXPath语法。
有关自定义使用的方法，请参阅XPath文档。
term
description
term
description
term定义的项，该项将在text中定义。
description目符号列表或编号列表中的项或者term的定义。
块用于定义表或定义列表中的标题行。
定义表时，只需为标题中的项提供一个项。
列表中的每一项用- 块指定。
创建定义列表时，既需要指定term也需要指定text。
但是，对于表、项目符号列表或编号列表，只需为text提供一个项。
列表或表所拥有的- 块数可以根据需要而定。
description
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member转换为输出XML中的规范化元素名。
必须将member括在双引号（""）中。
description成员的访问的说明。
标记使您得以将成员的访问记入文档。
System.Security.PermissionSet使您得以指定对成员的访问。
description
description成员的说明。
标记是可以指定有关类或其他类型的概述信息的位置。
是可以描述该类型的成员的位置。
description
description返回值的说明。
标记应当用于方法声明的注释，以描述返回值。
property-description
property-description属性的说明。
标记使您得以描述属性。
请注意，当在VisualStudio.NET开发环境中通过代码向导添加属性时，它将会为新属性添加标记。
然后，应该手动添加标记以描述该属性所表示的值。
团队项目开发"编码规范"之四：
申明
4.1每行声明数
一行只作一个声明,如
intlevel;//推荐
intsize;//推荐
intx,y;//不推荐
4.2初始化
建议在变量声明时就对其做初始化。
4.3位置
变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。
如
voidMyMethod（）
{
intint1=0;//beginningofmethodblock
if（condition）
{
intint2=0;//beginningof"if"block
...
}
}
不过也有一个例外
for（inti=0;i{
...
}
应避免不同层次间的变量重名，如
intcount;
...
voidMyMethod（）
{
if（condition）
{
intcount=0;//避免
...
}
...
}
4.4类和接口的声明
1在方法名与其后的左括号间没有任何空格。
2左花括号“{”出现在声明的下行并与之对齐，单独成行。
3方法间用一个空行隔开。
4.5字段的声明
不要使用是public或protected的实例字段。
如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。
考虑为字段提供get和set属性访问器，而不是使它们成为公共的。
get和set属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。
下面的代码示例阐释带有get和set属性访问器的私有实例字段的正确使用。
示例：
publicclassControl:
Component
{
privateinthandle;
publicintHandle
{
get
{
returnhandle;
}
}
}
团队项目开发"编码规范"之五：
命名规范
5.1命名概述
名称应该说明“什么”而不是“如何”。
通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。
例如，可以使用GetNextStudent（），而不是GetNextArrayElement（）。
命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。
使名称足够长以便有一定的意义，并且足够短以避免冗长。
唯一名称在编程上仅用于将各项区分开。
表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。
不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称，如方面名AnalyzeThis（），或者属性名xxK8。
这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的，如Book.BookTitle。
而是应该使用Book.Title。
3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。
4、在变量名中使用互补对，如min/max、begin/end和open/close。
5、布尔变量名应该包含Is，这意味着Ye
升级会员 