C# 编程规范.docx
- 文档编号:23657588
- 上传时间:2023-05-19
- 格式:DOCX
- 页数:19
- 大小:24.30KB
C# 编程规范.docx
《C# 编程规范.docx》由会员分享,可在线阅读,更多相关《C# 编程规范.docx(19页珍藏版)》请在冰豆网上搜索。
C#编程规范
1规范制定原则
1)方便代码的交流和维护。
2)不影响编码的效率,不与大众习惯冲突。
3)使代码更美观、阅读更方便。
4)使代码的逻辑更清晰、更易于理解。
2术语定义
Pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
例如:
BackColor
Camel大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。
例如:
backColor
3文件
1、文件命名
1)文件名遵从Pascal命名法,无特殊情况,扩展名小写。
2)使用统一而又通用的文件扩展名:
C#类.cs
2、文件注释
在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
//Copyright(C)2008××有限公司
//版权所有。
//
//文件名:
//文件功能描述:
//----------------------------------------------------------------*/
文件功能描述只需简述,具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的姓名、姓名拼音或英文名加日期组成。
如:
于国江20080408
4列宽
代码列宽控制在110字符左右。
5换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
6缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
VisualStudio.Net设置:
工具->选项->文本编辑器->C#->制表符->插入空格
7空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
在以下情况下使用两个空行
1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行,但与其他的语句间空一行。
8空格
在以下情况中要使用到空格
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)
9括号---()
没有必要的话不要在返回语句中使用()。
如
if(condition)
Array.Remove
(1)
return1
10花括号
1、左花括号“{”放于关键字或方法名的下一行并与之对齐。
如
if(condition)
{
}
publicintAdd(intx,inty)
{
}
2、左花括号“{”要与相应的右花括号“}”对齐。
3、通常情况下左花括号“{”单独成行,不与任何语句并列一行。
4、if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。
如
if(somevalue==1)
{
somevalue=2;
}
11注释
1、注释概述
1、修改代码时,总是使代码周围的注释保持最新。
2、在每个函数的开始,提供标准的注释样本以指示函数的用途、假设和限制很有帮助。
注释样本应该是解释它为什么存在和可以做什么的简短介绍.
3、避免在代码行的末尾添加注释;行尾注释使代码更难阅读。
不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释在公共制表位处对齐。
4、避免杂乱的注释,如一整行星号。
而是应该使用空白将注释同代码分开。
5、避免在块注释的周围加上印刷框。
这样看起来可能很漂亮,但是难于维护。
6、在部署发布之前,移除所有临时或无关的注释,以避免在日后的维护工作中产生混乱。
7、如果需要用注释来解释复杂的代码节,请检查此代码以确定是否应该重写它。
尽一切可能不注释难以理解的代码,而应该重写它。
尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
8、在编写注释时使用完整的句子。
注释应该阐明代码,而不应该增加多义性。
9、在编写代码时就注释,因为以后很可能没有时间这样做。
以后如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。
10、避免多余的或不适当的注释,如幽默但不主要的备注。
11、使用注释来解释代码的意图。
它们不应作为代码的联机翻译。
12、注释代码中不十分明显的任何内容。
13、为了防止问题反复出现,对错误修复和解决方法代码总是使用注释,尤其是在团队环境中。
14、对由循环和逻辑分支组成的代码使用注释。
这些是帮助源代码读者的主要方面。
15、在整个应用程序中,使用具有一致的标点和结构的统一样式来构造注释。
16、用空白将注释同注释分隔符分开。
在没有颜色提示的情况下查看注释时,这样做会使注释很明显且容易被找到。
2、文档型注释
该类注释采用.Net已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。
如
///
///添加警告
///
///
///
publicboolAddAlarm(Model.AlarmItemalarmItem)
{
}
3、单行注释
1)方法内的代码注释。
如变量的声明、代码或代码段的解释。
注释示例:
//
//注释语句
//
privateintnumber;
或
//注释语句
privateintnumber;
2)方法内变量的声明或花括号后的注释,注释示例:
if(1==1)//永远为true
{
statement;
}//永远为true
12声明
一行只作一个声明,并按字母顺序排列。
如
intlevel;//推荐
intsize;//推荐
intx,y;//不推荐
在变量声明时就对其做初始化。
变量置于块的开始处,不要总是在第一次使用它们的地方做声明。
如
voidMyMethod()
{
intint1=0;//方法块的开始处
if(condition)
{
intint2=0;//beginningof"if"block
...
}
}
不过也有一个例外
for(inti=0;i { ... } 应避免不同层次间的变量重名,如 intcount; ... voidMyMethod() { if(condition) { intcount=0;//避免 ... } ... } 考虑为字段提供get和set属性访问器,而不是使它们成为公共的。 下面的代码示例阐释带有get和set属性访问器的私有实例字段的正确使用。 示例: publicclassControl: Component { privateinthandle; publicintHandle { set { handle=value; } get { returnhandle; } } } 13命名规范 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,这意味着Yes/No或True/False值,如: fileIsFound。 6)在命名状态变量时,避免使用诸如Flag的术语。 状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。 不是使用documentFlag,而是使用更具描述性的名称,如documentFormatType。 (此项只供参考) 7)即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。 仅对于短循环索引使用单字母变量名,如i或j(主要应用在循环里) 2、大小写规则 大写 仅对于由两个或者更少字母组成的标识符允许标识符中的所有字母都大写。 例如: System.IO System.Web.UI 下表汇总了大写规则,并提供了不同类型的标识符的示例。 标识符 大小写 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意总是以Exception后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable 注意总是以I前缀开始。 方法 Pascal ToString 命名空间 Pascal System.Drawing 属性 Pascal BackColor 公共实例字段 Pascal RedValue 注意很少使用。 属性优于使用公共实例字段。 受保护的实例字段 Camel redValue 注意很少使用。 属性优于使用受保护的实例字段。 私有的实例字段 Camel redValue 参数 Camel typeName 方法内的变量 Camel backColor 3、缩写 为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则: 1)不要将缩写或缩略形式用作标识符名称的组成部分。 例如: 使用GetWindow,而不要使用GetWin。 2)不要使用计算机领域中未被普遍接受的缩写。 3)在适当的时候,使用众所周知的缩写替换冗长的词组名称。 例如: 用UI作为UserInterface缩写,用OLAP作为On-lineAnalyticalProcessing的缩写。 4)在使用缩写时,对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。 例如: 使用HtmlButton或HTMLButton。 但是,应当大写仅有两个字符的缩写,如,System.IO,而不是System.Io。 5)不要在标识符或参数名称中使用缩写。 如果必须使用缩写,对于由多于两个字符所组成的缩写请使用Camel大小写,虽然这和单词的标准缩写相冲突。 4、命名空间 1)命名空间使用Pascal大小写,用逗号分隔开。 2)命名空间和类不能使用同样的名字。 例如,有一个类被命名为Debug后,就不要再使用Debug作为一个名称空间名。 5、类 1)使用Pascal大小写。 2)用名词或名词短语命名类。 3)使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML 4)不要使用类型前缀,如在类名称上对类使用C前缀。 例如,使用类名称FileStream,而不是CFileStream。 5)不要使用下划线字符“_”。 6)有时候需要提供以字母I开始的类名称,虽然该类不是接口。 例如,类名称IdentityStore是适当的。 在适当的地方,使用复合单词命名派生的类。 派生类名称的第二个部分应当是基类的名称。 例如,ApplicationException对于从名为Exception的类派生的类是适当的名称。 请在应用该规则时进行合理的判断。 例如,Button对于从Control派生的类是适当的名称。 尽管按钮是一种控件,但是将Control作为类名称的一部分将使名称不必要地加长。 publicclassFileStream publicclassButton publicclassString 6、参数 1)使用描述性参数名称。 参数名称应当具有足够的描述性,以便参数的名称及其类型可用于在大多数情况下确定它的含义。 2)对参数名称使用Camel大小写。 3)使用描述参数的含义的名称,而不要使用描述参数的类型的名称。 开发工具将提供有关参数的类型的有意义的信息。 因此,通过描述意义,可以更好地使用参数的名称。 少用基于类型的参数名称,仅在适合使用它们的地方使用它们。 4)不要使用保留的参数。 保留的参数是专用参数,如果需要,可以在未来的版本中公开它们。 相反,如果在类库的未来版本中需要更多的数据,请为方法添加新的重载。 5)不要给参数名称加匈牙利语类型表示法的前缀。 以下是正确命名的参数的示例。 TypeGetType(stringtypeName) stringFormat(stringformat,args()Asobject) 7、方法 1)使用动词或动词短语命名方法。 2)使用Pascal大小写。 3)以下是正确命名的方法的实例。 RemoveAll() GetCharArray() Invoke() 8、属性(property) 1)使用名词或名词短语命名属性。 2)使用Pascal大小写。 3)考虑用与属性的基础类型相同的名称创建属性。 例如,如果声明名为Color的属性,则属性的类型同样应该是Color。 以下代码示例阐释正确的属性命名。 publicclassSampleClass { publicColorBackColor { …… } } 以下代码示例阐释提供其名称与类型相同的属性。 publicenumColor { …… } publicclassControl { publicColorColor { get { …… } set { …… } } } 9、常量(const) 所有单词大写,多个单词之间用"_"隔开。 如 10、publicconststringPAGE_TITLE="Welcome"; 14语句 1、每行最多包含一个语句。 如 a++;//推荐 b--;//推荐 2、复合语句是指包含"父语句{子语句;子语句;}"的语句,使用复合语句应遵循以下几点 1)子语句要缩进。 2)左花括号“{”在复合语句父语句的下一行并与之对齐,单独成行。 3)即使只有一条子语句要不要省略花括号“{}”。 如 while(d+=s++) { n++; } 3、return语句中不使用括号,除非它能使返回值更加清晰。 如 return; returnmyDisk.size(); return(size? size: defaultSize); 4、if、if-else、ifelse-if语句使用格式 if(condition) { statements; } if(condition) { statements; } else { statements; } if(condition) { statements; } elseif(condition) { statements; } else { statements; } 5、for、foreach语句 for语句使用格式 for(initialization;condition;update) { statements; } 空的for语句使用格式 for(initialization;condition;update); foreach语句使用格式 foreach(objectobjinarray) { statements; } 注意: 1)在循环过程中不要修改循环计数器。 2)对每个空循环体给出确认性注释。 6、while语句 while(condition) { statements; } 空的while语句使用格式 while(condition); 7、do-while语句 do { statements; }while(condition); 8、switch-case语句 switch(condition) { case1: statements; break; case2: statements; break; default: statements; break; } 注意: 1)switch语句中的每个case各占一行。 2)switch语句中的case按字母顺序排列。 3)为所有switch语句提供default分支。 4)所有的非空case语句必须用break;语句结束。 9、try-catch语句 try { statements; } catch(ExceptionClasse) { statements; } finally { statements; } 15控件命名规则 控件名简写+英文描述,英文描述首字母大写 控件名简写控件名简写 LabellblTextBoxtxt ButtonbtnLinkButtonlnkbtn ImageButtonimgbtnDropDownListddl ListBoxlstDataGriddg DataListdlCheckBoxchk CheckBoxListchklsRadioButtonrdo RadioButtonListrdoltImageimg PanelpnlCalendercld AdRotatorarTabletbl RequiredFieldValidatorrfvCompareValidatorcv RangeValidatorrvRegularExpressionValidatorrev ValidatorSummaryvsCrystalReportViewerrptvew 16其他 1)避免在表达式中用赋值语句 2)避免对浮点类型做等于或不等于判断 3)尽量避免强制类型转换。 4)如果不得不做类型转换,尽量用显式方式。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- C# 编程规范 编程 规范