程序员开发手册范本.docx
《程序员开发手册范本.docx》由会员分享，可在线阅读，更多相关《程序员开发手册范本.docx（53页珍藏版）》请在冰点文库上搜索。
程序员开发手册范本
《安全生产信息化管理系统》
程序员开发手册
1概述
1.1目的
1、方便代码的交流和维护。
2、不影响编码的效率，不与大众习惯冲突。
3、使代码更美观、阅读更方便。
4、使代码的逻辑更清晰、更易于理解。
1.2范围
本手册适用于开发部全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
1.3警示
通过自动检查【Microsoft.StyleCop】或人工检查【部门主管或相关负责人】不符合编码规范的，必须在限期【部门主管或相关负责人指定时间】内修正,逾期视为工作过失，部门主管或相关负责人视具体情况做出相关处理。
1.4术语定义
1、匈牙利命名法【禁用】
标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。
例如：
aUserId 数组（Array）定义以小写字母a开头
2、帕斯卡（pascal）命名法【推荐】
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
例如：
UserId
3、骆驼（Camel）命名法【推荐】
标识符的首字母小写，而每个后面连接的单词的首字母都大写。
例如：
userId
2代码格式
2.1列宽
1、为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在一般显示频率下不得超过一显示屏，代码列宽控制在110字符左右。
2、系统中部分代码可以不遵循此原则。
如：
VIWFormItemDetail[]dv=（VIWFormItemDetail[]）MHelper.SQLCommand.query（sql,VIWFormItemDetail.TName,sqlParams）;
3、SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上原则。
2.2换行
1、当表达式超出或即将超出规定的列宽，一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。
StringquerySql=“SELECTProjectId”+“,ProjectTitle”+“FROMProject”
2、每一行上放置的语句避免超过一条。
3、当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
（1）在逗号前换行。
（2）在操作符前换行。
（3）规则1优先于规则2。
例如：
StringBuilderquerySql=newStringBuilder（）;
querySql.Append（"SELECTa.ProjectIdASPK"）;
querySql.Append（",a.ProjectTitle"）;
querySql.Append（",a.ProjectDisplayCode"）;
querySql.Append（",a.IsbnCodeASISBNCode"）;
querySql.Append（"FROMProjecta"）;
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
2.3缩进
缩进应该是每行一个Tab（4个空格），不要在代码中使用Tab字符。
VisualStudio.Net设置：
工具->选项->文本编辑器->C#->制表符->插入空格
2.4空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
在以下情况下使用两个空行
1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行，但与其他的语句间空一行。
2.5空格
在以下情况中要使用到空格
1、关键字和左括符“（”应该用空格隔开。
如
while（true）
注意;在方法名和左括符“（”之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。
多个参数用逗号隔开，每个逗号后都应加一个空格。
2、除了.之外，所有的二元操作符都应用空格与它们的操作数隔开。
一元操作符、++及--与操作数间不需要空格。
如
a+=c+d;
a=（a+b）/（c*d）;
while（d++=s++）
{
n++;
}
PrintSize（“sizeis“+size+“\n”）;
3、语句中的表达式之间用空格隔开。
如
for（expr1;expr2;expr3）
4、以下写法是不允许的：
intj=i+k;
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;
}
右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。
如
while
（1）
{
if（valid）
{
}//ifvalid
else
{
}//notvalid
}//endforever
以下情况是不允许的：
if（x==0）{Response.Write（"用户编号必须输入！
"）; }或者：
if（x==0）{Response.Write（"用户编号必须输入！
"）;}
2.8分解
将大的复杂代码节分为较小的、易于理解的模块。
2.9SQL
1、编写SQL语句时，对于关键字或保留字使用全部大写，对于数据库元素（如表、列和视图等命名）使用帕斯卡命名法命名。
如：
SELECTUserIdASEmIdFROMUser
SELECTUserIdASEmIdFROMUserASem
SELECTUserIdASEmIdFROMUserASEM
等允许使用；
2、将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句。
例如：
SELECTFirstName,LastNameFROMCustomersWHEREState='WA';
3、不要从数据表中调用页面或程序不需要的字段；
2.10引用
1、对于程序中字段名称的引用要通过对应的属性调用实现。
如：
IntuserId=（int）Dv[0][“UserId”];是不允许的；
IntuserId=（int）Dv[0][User.x.UserId.ColumnName];是允许的；
stringbookPriceName=Book.x.BookPrice.ColumnName;
decimal?
bookPrice=null;
if（dr[bookPriceName]!
=DBNull.Value）
{
bookPrice=（decimal）dr[bookPriceName];
}
是允许的；
3程序注释
3.1注释概述
1、修改代码时，总是使代码周围的注释保持最新。
2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。
注释样本应该是解释它为什么存在和可以做什么的简短介绍。
3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。
不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。
4、避免杂乱的注释，如一整行星号。
而是应该使用空白将注释同代码分开。
5、避免在块注释的周围加上印刷框。
这样看起来可能很漂亮，但是难于维护。
6、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。
7、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。
尽一切可能不注释难以理解的代码，而应该重写它。
尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。
8、在编写注释时使用完整的句子。
注释应该阐明代码，而不应该增加多义性。
9、在编写代码时就注释，因为以后很可能没有时间这样做。
另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。
10、避免多余的或不适当的注释，如幽默的不主要的备注。
11、使用注释来解释代码的意图。
它们不应作为代码的联机翻译。
12、注释代码中不十分明显的任何内容。
13、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。
14、对由循环和逻辑分支组成的代码使用注释。
这些是帮助源代码读者的主要方面。
15、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。
16、用空白将注释同注释分隔符分开。
在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。
17、在所有的代码修改处加上修改内容的注释（此项只供参考）。
18、对于常量、变量、表达式等使用单行注释时建议放到声明的后面；
19、对于常量、变量、表达式等建议使用单行注释，单行注释格式如：
privateintnumber;//注释语句
或：
////注释语句
privateintnumber;
20、为了使层次清晰，在闭合的右花括号后注释该闭合所对应的起点（此项只供参考）。
namespaceLangchao.Procument.Web
{
}//namespaceLangchao.Procument.Web
3.2文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。
如
///MyMethodisamethodintheMyClassclass.
///Here'showyoucouldmakeasecondparagraphinadescription.
///
///forinformationaboutoutputstatements.
///
///
///
publicstaticvoidMyMethod（intInt1）
{
}
又如：
类属性注释规范
在类的属性必须以以下格式编写属性注释：
///
///属性说明
///
方法注释规范
在类的方法声明前必须以以下格式编写注释
///
///说明：
<对该方法的说明>
///
///"><参数说明>
///
///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>
///
3.3类c注释（此项只供参考）
该类注释用于
1、不再使用的代码。
2、临时测试屏蔽某些代码。
用法
/*
[修改标识]
[修改原因]
...（thesourcecode）
*/
3.4单行注释
该类注释用于
1、方法内的代码注释。
如变量的声明、代码或代码段的解释。
注释示例：
///
///注释语句
///
privateintnumber;
或
////注释语句
privateintnumber;
或
privateintnumber;//注释语句
2、方法内变量的声明或花括号后的注释,注释示例：
if（1==1）//alwaystrue
{
statement;
}//alwaystrue
3.5文件注释
文件功能描述只需简述，具体详情在类的注释中描述。
3.6注释标签
标签
用法
作用
c>错误!
超链接引用无效。
text希望将其指示为代码的文本。
为您提供了一种将说明中的文本标记为代码的方法。
使用将多行指示为代码
错误!
超链接引用无效。
content段落文本。
用于诸如或等标记内，使您得以将结构添加到文本中。
超链接引用无效。
'>错误!
超链接引用无效。
name为方法参数名。
将此名称用单引号括起来（''）。
应当用于方法声明的注释中，以描述方法的一个参数。
超链接引用无效。
"/>
name
要引用的参数名。
将此名称用双引号括起来（""）。
标记为您提供了一种指示词为参数的方法。
可以处理XML文件，从而用某种独特的方法格式化该参数。
超链接引用无效。
错误!
超链接引用无效。
"member"/>
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member传递给输出XML中的元素名。
必须将member括在双引号（""）中。
使您得以从文本内指定链接。
使用指示希望在“请参阅”一节中出现的文本。
超链接引用无效。
错误!
超链接引用无效。
"member"/>
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member传递给输出XML中的元素名。
必须将member括在双引号（""）中
使您得以指定希望在“请参阅”一节中出现的文本。
使用从文本
错误!
超链接引用无效。
description
代码示例的说明。
使用标记可以指定使用方法或其他库成员的示例。
一般情况下，这将涉及到标记的使用。
错误!
超链接引用无效。
content为希望将其标记为代码的文本。
记为您提供了一种将多行指示为代码的方法。
使用指示应将说明中的文本标记为代码
错误!
超链接引用无效。
此处description为对象的摘要。
应当用于描述类型成员。
使用以提供有关类型本身的信息。
超链接引用无效。
错误!
超链接引用无效。
"member">错误!
超链接引用无效。
cref="member"对可从当前编译环境中获取的异常的引用。
编译器检查到给定异常存在后，将member转换为输出XML中的规范化元素名。
必须将member括在双引号（""）中。
description说明。
标记使您可以指定类能够引发的异常。
超链接引用无效。
'path='错误!
超链接引用无效。
[@错误!
超链接引用无效。
="错误!
超链接引用无效。
"]'/>
filename包含文档的文件名。
该文件名可用路径加以限定。
将filename括在单引号中（''）。
Tagpath：
filename中指向标记名的标记路径。
将此路径括在单引号中（''）。
name注释前边的标记中的名称说明符；名称具有一个id。
id
位于注释之前的标记的id。
将此id括在双引号中（""）。
标记使您得以引用描述源代码中类型和成员的另一文件中的注释。
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
标记使用XMLXPath语法。
有关自定义使用的方法，请参阅XPath文档。
错误!
超链接引用无效。
错误!
超链接引用无效。
错误!
超链接引用无效。
错误!
超链接引用无效。
term定义的项，该项将在text中定义。
description目符号列表或编号列表中的项或者term的定义。
块用于定义表或定义列表中的标题行。
定义表时，只需为标题中的项提供一个项。
列表中的每一项用- 块指定。
创建定义列表时，既需要指定term也需要指定text。
但是，对于表、项目符号列表或编号列表，只需为text提供一个项。
列表或表所拥有的- 块数可以根据需要而定。
超链接引用无效。
错误!
超链接引用无效。
"member">错误!
超链接引用无效。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后，将member转换为输出XML中的规范化元素名。
必须将member括在双引号（""）中。
description成员的访问的说明。
标记使您得以将成员的访问记入文档。
System.Security.PermissionSet使您得以指定对成员的访问。
错误!
超链接引用无效。
description成员的说明。
标记是可以指定有关类或其他类型的概述信息的位置。
是可以描述该类型的成员的位置。
错误!
超链接引用无效。
description返回值的说明。
标记应当用于方法声明的注释，以描述返回值。
错误!
超链接引用无效。
property-description属性的说明。
标记使您得以描述属性。
请注意，当在VisualStudio.NET开发环境中通过代码向导添加属性时，它将会为新属性添加标记。
然后，应该手动添加标记以描述该属性所表示的值。
4申明
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命名规范
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
升级会员 