编码规范大全
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
三、规范化注释 1、文件级注释 文件级注释在于说明整个代码文件的功能，常常还包含作者信息、创建日期信息等，以便于 代码的后期维护。 /****文档注释****************************************************************
C#代码规则
一、规范化命名 规范总则： Pascal 风格：包含一到多个单词，每一个单词第一个字母大写，其他字母小写。 Camel 风格：包含一到多个单词，第一个单词首字母小写，其余单词首字母大写，其余字母 均小写。
1 ADO.NET 命名规范
数据类型 Connection Command Parameter DataAdapter DataReader DataSet DataTable DataRow DataColumn DataRelation DataView
Get {
return this.m_name; } }
///<summary> ///方法名：Pascal 命名风格 ///</summary> public void EnterSchool(){.....} } 另外，方法常常使用一些前缀来表意，如下所示 (1)Is：含义为问一个关于某样事物的问题，如 IsMale()。 (2)Get：含义为取得一个数值，例如 GetInnfo()。 (3)Set：含义为设定一个数值，例如 SetInfo()。
clst cbo lvw tvw tctl dtp hsb vsb tmr ilst tlb stb odlg sdlg fbdlg fdlg cdlg pdlg
clstChecked cboMenu lvwBrowser tvwType tctlSelected dtpStartDate hsbImage vsbImage tmrCount ilstImage tlbManage stbFootPrint odlgFile sdlgSave fgdlgBrowser fdlgFoot cdlgColor pdlgPrint
2 WinForm Control 命名规范
数据类型 Label LinkLabel Button TextBox MainMenu CheckBox RadioButton GroupBox PictureBox Panel DataGrid ListBox
数据类型简写 lbl llbl btn txt mmnu chk rbtn gbx pic pnl dgrd lst
get {
return this.m_name; } }
///<summary> ///方法名：Pascal 命名风格 ///</summary> public void EnterSchool(){.....} public void SetInfomation(string name,int age){......} }
4、属性 用名词或名词短语命名属性,类的属性才采用 Pascal 风格。 class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age; ///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {
Label LinkButton ListBox Panel PlaceHolder RadioButton RadioButtonList RangeValidator RegularExpression Repeater RequiredFieldValidator Table TableCell TableRow TextBox ValidationSummary XML
8、变量 局部变量采用 camel 风格，并尽可能使用描述性强的名词或名词短语，并尽量不使用缩写， 如使用 number，而不使用 num。 int number = 0; string sqlString = ""; double averageScore = 0.0; CollegeStudent collegeStudent = new CollegeStudent();
数据类型简写 con cmd parm dad dtr dst dtbl drow dcol drel dvw
标准命名举例 conNorthwind cmdReturnProducts parmProductID dadProducts dtrProducts dstNorthWind dtblProduct drowRow98 dcolProductID drelMasterDetail dvwFilteredProducts
1、命名空间的命名规则 采用 Pascal 风格。
2、类： 采用 Pascal 风格，取名规则如下。 (1)在为类命名前首先要知道它的作用，尽量以名词或名词短语命名，使程序员仅通过类名 提供的线索，便可以了解这个类的基本功能。 (2)尽量不使用缩写，而用全写，例如：使用 CollegeStudent 而不用 CollegeStu。 (3)不要使用任何类前缀(例如 C)，和后缀(例如 Class)。 (4)不要使用带下划线的字符(例如：College_Student)。 代码 1-1 类命名示例 ///<summary> ///类名：Pascal 命名风格，形如 SomeClass。 ///</summary> public class CollegeStudent {
9、事件 用 EventHandloer 后缀命名事件处理程序，使用名为 sender 和 e 的两个参数，Sender 参数代表提出事件的对象。Sender 参数永远是一个类型对象，即使它可能使用了更为特定 的类型，与事件相关的状态被封装在一个名为 e 的事件类范例中。要使用这个类型的正确 的、特定的事件类。 public delegate void MouseEventHandler(object sender, MouseEvent e);
while (condition) {
...... } }
规范化小括号的使用 (1)尽量使用空格把关键词和小括号隔开，这样可以使关键词更加醒目。 If (condition) {
...... } (2)尽量使用空格把函数名和小括号隔开，可以使函数名更加醒目： void MyMethod (...) { } (3)尽量不要在 return 语句中使用小括号。 result = (x>y)?1:0; return result; 不要写成： return (x>y)?1:0;
3 WebControl 命名规范
数据类型 AdRotator Button Calendar CheckBox CheckBoxList CompareValidator CustomValidator DataGrid DataList DropDownList HyperLink Image ImageButton
数据类型简写 adrt btn cal chk chkl valc valx dgrd dlst drop lnk img ibtn
标准命名举例 Example btnSubmit calMettingDates chkBlue chklFavColors valcValidAge valxDBCheck dgrdTitles dlstTitles dropCountries lnkDetails imgAuntBetty ibtnSubmit
标准命名举例 lblMessage llblToday btnSave txtName mmnuFile chkStock rbtnSelected gbxMain picImage pnlBody dgrdView lstProducts
CheckedListBox ComboBox ListView TreeView TabControl DateTimePicker HscrollBar VscrollBar Timer ImageList ToolBar StatusBar OpenFileDialog SaveFileDialog FoldBrowserDialog FontDialog ColorDialog PrintDialog
lbl lbtn lst pnl plh rad radl valg vale rpt valr tbl tblc tblr txt vals xmlc
lblResults lbtnSubmit lstCountries pnlForm2 plhFormContents radFemale radlGender valgAge valeEmail_Validator rptQueryResults valrFirstName tblCountryCodes tblcGermany tblrCountry txtFirstName valsFormErrors xmlcTransformResults
10、自定义的异常以 Exception 结尾 public class AppException : Exception {
} 二、规范化大括号和代码缩进 大括号和制表符(Tab 键)形成代码缩进。 (1)将大括号放置在关键词，如 if、while、for 等的下方同列处，例如： if (condition) {
…… }
3、私有成员 类的成员变量采用 Camel 风格，并使用前缀 m_或者_。下面是一些合理的私有成员示例。
class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age; }
7、接口： 与方法相似，接口采用 Pascal 命名规范，规则如下。 (1)使用 I 作为前缀，标示其为一个接口。 (2)使用名词或名词短语，或者描述行为的形容词来命名接口。如:IComponent(描述性名词)。 (3)尽量不要使用缩写，而用全写。 (4)不要使用带下划线的字符。
///<summary> ///接口名：Pascal 命名风格 ///</summary> public interface IPlay{};
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary>
private string m_name; private int m_age; ///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {
Gቤተ መጻሕፍቲ ባይዱt {
return this.m_name; } } } 自定义的属性以 Attribute 结尾： public class AuthorAttribute : Attribute {
}
5、方法 通常每个方法都是执行类的一个“动作”，所以对它们的命名应该清楚的说明它们是做什么 的，用“动词+名词”的结构可以更加清晰地表达这种含义。例如：ShowInfo()代替 Info()，用 LoadData()代替 DataLoad()，这样做的目的是更加明确这个方法的功能。 class CollegeStudent {
6、方法参数 方法参数采用 camel 风格。 class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age;
///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {
C#代码规则
一、规范化命名 规范总则： Pascal 风格：包含一到多个单词，每一个单词第一个字母大写，其他字母小写。 Camel 风格：包含一到多个单词，第一个单词首字母小写，其余单词首字母大写，其余字母 均小写。
1 ADO.NET 命名规范
数据类型 Connection Command Parameter DataAdapter DataReader DataSet DataTable DataRow DataColumn DataRelation DataView
Get {
return this.m_name; } }
///<summary> ///方法名：Pascal 命名风格 ///</summary> public void EnterSchool(){.....} } 另外，方法常常使用一些前缀来表意，如下所示 (1)Is：含义为问一个关于某样事物的问题，如 IsMale()。 (2)Get：含义为取得一个数值，例如 GetInnfo()。 (3)Set：含义为设定一个数值，例如 SetInfo()。
clst cbo lvw tvw tctl dtp hsb vsb tmr ilst tlb stb odlg sdlg fbdlg fdlg cdlg pdlg
clstChecked cboMenu lvwBrowser tvwType tctlSelected dtpStartDate hsbImage vsbImage tmrCount ilstImage tlbManage stbFootPrint odlgFile sdlgSave fgdlgBrowser fdlgFoot cdlgColor pdlgPrint
2 WinForm Control 命名规范
数据类型 Label LinkLabel Button TextBox MainMenu CheckBox RadioButton GroupBox PictureBox Panel DataGrid ListBox
数据类型简写 lbl llbl btn txt mmnu chk rbtn gbx pic pnl dgrd lst
get {
return this.m_name; } }
///<summary> ///方法名：Pascal 命名风格 ///</summary> public void EnterSchool(){.....} public void SetInfomation(string name,int age){......} }
4、属性 用名词或名词短语命名属性,类的属性才采用 Pascal 风格。 class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age; ///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {
Label LinkButton ListBox Panel PlaceHolder RadioButton RadioButtonList RangeValidator RegularExpression Repeater RequiredFieldValidator Table TableCell TableRow TextBox ValidationSummary XML
8、变量 局部变量采用 camel 风格，并尽可能使用描述性强的名词或名词短语，并尽量不使用缩写， 如使用 number，而不使用 num。 int number = 0; string sqlString = ""; double averageScore = 0.0; CollegeStudent collegeStudent = new CollegeStudent();
数据类型简写 con cmd parm dad dtr dst dtbl drow dcol drel dvw
标准命名举例 conNorthwind cmdReturnProducts parmProductID dadProducts dtrProducts dstNorthWind dtblProduct drowRow98 dcolProductID drelMasterDetail dvwFilteredProducts
1、命名空间的命名规则 采用 Pascal 风格。
2、类： 采用 Pascal 风格，取名规则如下。 (1)在为类命名前首先要知道它的作用，尽量以名词或名词短语命名，使程序员仅通过类名 提供的线索，便可以了解这个类的基本功能。 (2)尽量不使用缩写，而用全写，例如：使用 CollegeStudent 而不用 CollegeStu。 (3)不要使用任何类前缀(例如 C)，和后缀(例如 Class)。 (4)不要使用带下划线的字符(例如：College_Student)。 代码 1-1 类命名示例 ///<summary> ///类名：Pascal 命名风格，形如 SomeClass。 ///</summary> public class CollegeStudent {
9、事件 用 EventHandloer 后缀命名事件处理程序，使用名为 sender 和 e 的两个参数，Sender 参数代表提出事件的对象。Sender 参数永远是一个类型对象，即使它可能使用了更为特定 的类型，与事件相关的状态被封装在一个名为 e 的事件类范例中。要使用这个类型的正确 的、特定的事件类。 public delegate void MouseEventHandler(object sender, MouseEvent e);
while (condition) {
...... } }
规范化小括号的使用 (1)尽量使用空格把关键词和小括号隔开，这样可以使关键词更加醒目。 If (condition) {
...... } (2)尽量使用空格把函数名和小括号隔开，可以使函数名更加醒目： void MyMethod (...) { } (3)尽量不要在 return 语句中使用小括号。 result = (x>y)?1:0; return result; 不要写成： return (x>y)?1:0;
3 WebControl 命名规范
数据类型 AdRotator Button Calendar CheckBox CheckBoxList CompareValidator CustomValidator DataGrid DataList DropDownList HyperLink Image ImageButton
数据类型简写 adrt btn cal chk chkl valc valx dgrd dlst drop lnk img ibtn
标准命名举例 Example btnSubmit calMettingDates chkBlue chklFavColors valcValidAge valxDBCheck dgrdTitles dlstTitles dropCountries lnkDetails imgAuntBetty ibtnSubmit
标准命名举例 lblMessage llblToday btnSave txtName mmnuFile chkStock rbtnSelected gbxMain picImage pnlBody dgrdView lstProducts
CheckedListBox ComboBox ListView TreeView TabControl DateTimePicker HscrollBar VscrollBar Timer ImageList ToolBar StatusBar OpenFileDialog SaveFileDialog FoldBrowserDialog FontDialog ColorDialog PrintDialog
lbl lbtn lst pnl plh rad radl valg vale rpt valr tbl tblc tblr txt vals xmlc
lblResults lbtnSubmit lstCountries pnlForm2 plhFormContents radFemale radlGender valgAge valeEmail_Validator rptQueryResults valrFirstName tblCountryCodes tblcGermany tblrCountry txtFirstName valsFormErrors xmlcTransformResults
10、自定义的异常以 Exception 结尾 public class AppException : Exception {
} 二、规范化大括号和代码缩进 大括号和制表符(Tab 键)形成代码缩进。 (1)将大括号放置在关键词，如 if、while、for 等的下方同列处，例如： if (condition) {
…… }
3、私有成员 类的成员变量采用 Camel 风格，并使用前缀 m_或者_。下面是一些合理的私有成员示例。
class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age; }
7、接口： 与方法相似，接口采用 Pascal 命名规范，规则如下。 (1)使用 I 作为前缀，标示其为一个接口。 (2)使用名词或名词短语，或者描述行为的形容词来命名接口。如:IComponent(描述性名词)。 (3)尽量不要使用缩写，而用全写。 (4)不要使用带下划线的字符。
///<summary> ///接口名：Pascal 命名风格 ///</summary> public interface IPlay{};
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary>
private string m_name; private int m_age; ///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {
Gቤተ መጻሕፍቲ ባይዱt {
return this.m_name; } } } 自定义的属性以 Attribute 结尾： public class AuthorAttribute : Attribute {
}
5、方法 通常每个方法都是执行类的一个“动作”，所以对它们的命名应该清楚的说明它们是做什么 的，用“动词+名词”的结构可以更加清晰地表达这种含义。例如：ShowInfo()代替 Info()，用 LoadData()代替 DataLoad()，这样做的目的是更加明确这个方法的功能。 class CollegeStudent {
6、方法参数 方法参数采用 camel 风格。 class CollegeStudent {
///<summary> ///私有成员命名：Camel 命名风格，形如 member。 ///</summary> private string m_name; private int m_age;
///<summary> ///属性命名：Pascal 命名风格 ///</summary> public string Name {