C代码编写规范.docx

1、C代码编写规范C#代码编写规范1目的a) 为了统一公司软件开发设计过程的编程规范；b) 使开发人员能方便的理解每个目录、变量、控件、类、方法的意义；c) 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范；d) 编码规范和约定必须能明显改善代码可读性，并有助于代码管理；2适应范围本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3术语及缩略语4规范内容命名总体规则a) 名字应该能够标识事物的特性。b) 名字一律使用英文单词，而不能为拼音。c) 名字尽量不使用缩写，除非它是众所周知的。d) 名字可以有两个或三个单词组成，

2、但不应多于三个，控制在3至30个字母以内。e) 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。f) 名字尽量使用前缀而不是后缀。g) 名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。命名规范4.2.1变量命名1、程序文件(*.cs)中的变量命名程序中变量名称 = 变量的前缀 +代表变量含意的英文单词或单词缩写。类模块级的变量请用“m_” +数据类型缩写作为前缀（其中，m 为“module”缩写，数据类型缩写见附件中的数据类型缩写表）。 public class

3、 Hello private string m_strName; private DataTable m_dtblTable;类的属性所对应的变量，采用属性名前加“m_”+ 类型缩写 前缀的形式 public class Hello private string m_strName; private DataTable m_dtblTable; public string Name get return m_strName; 过程级的变量使用类型缩写前缀 void Say() string strSayWord; 过程的参数使用“p_”+ 类型缩写作为前缀（其中，p 为“parameter”缩

4、写） void Say(string pStrSayWord) string strSayWord; 补充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为ex；如果有冲突的情况下，可以用“ex”+ 标志名称，如：exSql。 try 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。在变量名中使用互补对，如min/max、begin/end 和 open/close。不要使用原义数字或原义字符串，如 For (i = 1;i= 7;i+)。而是使用命名常数，如 For (i = 1;i

5、 = NUM_DAYS_IN_WEEK;i+) 以便于维护和理解。2、控件命名控件命名=控件缩写前缀 + “_” + 名称；如：DataGriddg_UserList 或 dgUserlist4.2.2常量命名常量名也应当有一定的意义，格式为 NOUN 或 NOUN_VERB。常量名均为大写，字之间用下划线分隔。例：private const bool WEB_ENABLEPAGECACHE_DEFAULT = true;private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;private const bool WEB_E

6、NABLESSL_DEFAULT = false;注：变量名和常量名最多可以包含 255 个字符，但是，超过 25 到 30 个字符的名称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25 或 30 个字符应当足够了。4.2.3类(Class)命名a)名字应该能够标识事物的特性。b)名字尽量不使用缩写，除非它是众所周知的。c)名字可以有两个或三个单词组成，但通常不应多于三个。d)在名字中，所有单词第一个字母大写。例如IsSuperUser，包含ID的，ID可以全部大写，如CustomerID。e)使用名词或名词短语命名类。 f)少用缩写。 g)不要使用下划线字符 (_

7、)。 例：public class FileStreampublic class Buttonpublic class String4.2.4接口(Interface)命名和类命名规范相同，唯一区别是接口在名字前加上“I”前缀。例：interface IMap；或interface IMapDocument：4.2.5方法(Method)命名和类命名规范相同；4.2.6命名空间(NameSpace)命名和类命名规范相同；4.2.7属性(Property)命名和类命名规范相同；注释规范4.3.1概述a) 注释要求英文及英文的标点符号。b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过

8、于详细的描述。c) 每行注释的最大长度为100个字符。d) 将注释与注释分隔符用一个空格分开。e) 不允许给注释加外框。f) 编码的同时书写注释。g) 重要变量必须有注释。h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。如：int m_iLevel,m_iCount; .tree level.count of tree items string m_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.7 Case规则default case总应该存在，如果不允许到达，则应该保证：若

9、到达了就会触发一个错误。Case的选择条件最好使用int或string类型。4.4.8 If Else规则如果你有用到else if 语句的话，通常最好有一个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控件名 缩写AdRotator artButton btnCalendar cdCh

10、eckBox chkCheckBoxList chklCompareValidator cpvCustomValidator ctvDataGrid dgDataList dlDropDownList ddlHyperLink hlImage imgImageButton IbtnLabel labLinkButton lbtnListBox lstPanel plPlaceHolder phRadioButton rbRadioButtonList rblRangeValidator rvRegularExpressionValidator revRepeater rpRequiredFie

11、ldValidator rfvTable tbTableCell tcTableRow trTextBox txtValidationSummary vsXML XMLb、html控件html控件名 缩写HtmlAnchor hahHtmlButton hbtnHtmlForm hformHtmlGenericControl hgcHtmlImage himgHtmlInputButton（按钮） htxtHtmlInputButton（重置） hrbtnHtmlInputButton（提交） hcbtnHtmlInputCheckBox hickHtmlInputFile hifileHtm

12、lInputHidden hihiddenHtmlInputImage hiimgHtmlInputRadioButton hirbHtmlInputText（密码） hpwdHtmlInputText（文本） hitxtHtmlSelect hsltHtmlTable htabHtmlTableCell htcHtmlTableRow htrHtmlTextArea htxtac、控件类型 前缀 示例Connection con conNorthwindCommand cmd cmdReturnProductsParameter parm parmProductIDDataAdapter dad dadProductsDataReader dtr dtrProductsDataSet dst dstNorthWindDataTable dtbl dtblProductDataRow drow drowRow98DataColumn dcol dcolProductIDDataRelation drel drelMasterDetailDataView dvw dvwFilteredProducts