C代码编写规范.docx
《C代码编写规范.docx》由会员分享，可在线阅读，更多相关《C代码编写规范.docx（7页珍藏版）》请在冰豆网上搜索。
C代码编写规范
C#代码编写规范
1目的
a）为了统一公司软件开发设计过程的编程规范；
b）使开发人员能方便的理解每个目录、变量、控件、类、方法的意义；
c）为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范；
d）编码规范和约定必须能明显改善代码可读性，并有助于代码管理；
2适应范围
本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3术语及缩略语
4规范内容
命名总体规则
a）名字应该能够标识事物的特性。
b）名字一律使用英文单词，而不能为拼音。
c）名字尽量不使用缩写，除非它是众所周知的。
d）名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。
e）在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。
例如：
IsSuperUser。
f）名字尽量使用前缀而不是后缀。
g）名字中的单词尽量使用名词，如有动词，也尽量放在后面。
例如：
FunctionUserDelete（而不是FunctionDeleteUser）。
命名规范
4.2.1变量命名
1、程序文件（*.cs）中的变量命名
程序中变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。
类模块级的变量请用“m_”+数据类型缩写作为前缀（其中，m为“module”缩写，数据类型缩写见附件中的《数据类型缩写表》）。
publicclassHello
{
privatestringm_strName;
privateDataTablem_dtblTable;
}
类的属性所对应的变量，采用属性名前加“m_”+类型缩写前缀的形式
publicclassHello
{
privatestringm_strName;
privateDataTablem_dtblTable;
publicstringName
{
get
{
returnm_strName;
}
}
}
过程级的变量使用类型缩写前缀
voidSay（）
{
stringstrSayWord;
}
过程的参数使用“p_”+类型缩写作为前缀（其中，p为“parameter”缩写）
voidSay（stringpStrSayWord）
{
stringstrSayWord;
}
补充说明：
针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为ex；
如果有冲突的情况下，可以用“ex”+标志名称，如：
exSql。
try
{
即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名，如i或j。
在变量名中使用互补对，如min/max、begin/end和open/close。
不要使用原义数字或原义字符串，如For（i=1;i<=7;i++）。
而是使用命名常数，如For（i=1;i<=NUM_DAYS_IN_WEEK;i++）以便于维护和理解。
2、控件命名
控件命名=控件缩写前缀+[“_”]+名称；如：
DataGriddg_UserList或dgUserlist
4.2.2常量命名
常量名也应当有一定的意义，格式为NOUN或NOUN_VERB。
常量名均为大写，字之间用下划线分隔。
例：
privateconstboolWEB_ENABLEPAGECACHE_DEFAULT=true;
privateconstintWEB_PAGECACHEEXPIRESINSECONDS_DEFAULT=3600;
privateconstboolWEB_ENABLESSL_DEFAULT=false;
注：
变量名和常量名最多可以包含255个字符，但是，超过25到30个字符的名称比较笨拙。
此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25或30个字符应当足够了。
4.2.3类（Class）命名
a）名字应该能够标识事物的特性。
b）名字尽量不使用缩写，除非它是众所周知的。
c）名字可以有两个或三个单词组成，但通常不应多于三个。
d）在名字中，所有单词第一个字母大写。
例如IsSuperUser，包含ID的，ID可以全部大写，如CustomerID。
e）使用名词或名词短语命名类。
f）少用缩写。
g）不要使用下划线字符（_）。
例：
publicclassFileStream
publicclassButton
publicclassString
4.2.4接口（Interface）命名
和类命名规范相同，唯一区别是接口在名字前加上“I”前缀。
例：
interfaceIMap；或interfaceIMapDocument：
4.2.5方法（Method）命名
和类命名规范相同；
4.2.6命名空间（NameSpace）命名
和类命名规范相同；
4.2.7属性（Property）命名
和类命名规范相同；
注释规范
4.3.1概述
a）注释要求英文及英文的标点符号。
b）注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c）每行注释的最大长度为100个字符。
d）将注释与注释分隔符用一个空格分开。
e）不允许给注释加外框。
f）编码的同时书写注释。
g）重要变量必须有注释。
h）变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。
如：
intm_iLevel,m_iCount;..treelevel
..countoftreeitems
stringm_strSql;4.3.24.3.34.3.44.3.54.3.64.4.14.4.24.4.34.4.44.4.54.4.6.
4.4.7Case规则
defaultcase总应该存在，如果不允许到达，则应该保证：
若到达了就会触发一个错误。
Case的选择条件最好使用int或string类型。
4.4.8If…Else规则
如果你有用到elseif语句的话，通常最好有一个else块以用于处理未处理到的其他情况。
可以的话放一个记录信息注释在else处，即使在else没有任何的动作。
其格式为：
if（条件1）4.4.94.4.104.4.114.4.124.4.134.4.144.4.154.4.164.4.174.5.14.5.24.5.34.5.44.5.54.5.64.6.14.6.24.7.14.7.2ET控件
web控件名缩写
AdRotatorart
Buttonbtn
Calendarcd
CheckBoxchk
CheckBoxListchkl
CompareValidatorcpv
CustomValidatorctv
DataGriddg
DataListdl
DropDownListddl
HyperLinkhl
Imageimg
ImageButtonIbtn
Labellab
LinkButtonlbtn
ListBoxlst
Panelpl
PlaceHolderph
RadioButtonrb
RadioButtonListrbl
RangeValidatorrv
RegularExpressionValidatorrev
Repeaterrp
RequiredFieldValidatorrfv
Tabletb
TableCelltc
TableRowtr
TextBoxtxt
ValidationSummaryvs
XMLXML
b、html控件
html控件名缩写
HtmlAnchorhah
HtmlButtonhbtn
HtmlFormhform
HtmlGenericControlhgc
HtmlImagehimg
HtmlInputButton（按钮）htxt
HtmlInputButton（重置）hrbtn
HtmlInputButton（提交）hcbtn
HtmlInputCheckBoxhick
HtmlInputFilehifile
HtmlInputHiddenhihidden
HtmlInputImagehiimg
HtmlInputRadioButtonhirb
HtmlInputText（密码）hpwd
HtmlInputText（文本）hitxt
HtmlSelecthslt
HtmlTablehtab
HtmlTableCellhtc
HtmlTableRowhtr
HtmlTextAreahtxta
c、控件
类型前缀示例
ConnectionconconNorthwind
CommandcmdcmdReturnProducts
ParameterparmparmProductID
DataAdapterdaddadProducts
DataReaderdtrdtrProducts
DataSetdstdstNorthWind
DataTabledtbldtblProduct
DataRowdrowdrowRow98
DataColumndcoldcolProductID
DataRelationdreldrelMasterDetail
DataViewdvwdvwFilteredProducts
升级会员 