C#命名规范

素颜马尾好姑娘i 2022-05-31 14:17 279阅读 0赞

**Pascal 规则（帕斯卡命名）**  
每个单词开头的字母大写(如 TestCounter).

**Camel 规则(大驼峰和小驼峰命名)**  
除了第一个单词外的其他单词的开头字母大写. 如. testCounter.

**Upper 规则**  
仅用于一两个字符长的常量的缩写命名,超过三个字符长度应该应用Pascal规则.

**类命名指导**  
\- 类名应该为名词及名词短语，尽可能使用完整的词  
\- 使用Pascal规则  
\- 在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称.例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因是 ApplicationException是一种 Exception。

请在应用该规则时进行合理的判断。  
例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。

**接口命名规则**  
接口名称应该为名词及名词短语或者描述其行为的形容词，尽可能使用完整的词。

** 枚举命名规则**  
\- 对于 Enum 类型和值名称使用 Pascal 大小写  
\- 少用缩写  
\- 不要在 Enum 类型名称上使用 Enum 后缀  
\- 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。  
\- 总是将 FlagsAttribute 添加到位域 Enum 类型  
   
 **变量命名**  
\- 使用 Camel 命名规则  
\- 在简单的循环语句中计数器变量使用 i, j, k, l, m, n  
   
**方法命名**  
\- 使用Pascal规则  
\- 对方法名采用一致的动词/宾语或宾语/动词顺序  
例如，将动词置于前面时，所使用的名称诸如 InsertWidget 和 InsertSprocket；将宾语置于前面时，所使用的名称诸如 WidgetInsert 和 SprocketInsert，在此推荐前者。

\- 不要在方法中重复类的名称

例如，如果某个类已命名为 Book，则不要将某个方法称为 Book.CloseBook，而可以将方法命名为 Book.Close。  
   
**属性命名**

\- 名称应该为名词及名词短语  
\- 使用Pascal规则  
\- 对于bool型属性或者变量使用Is（is）作为前缀，不要使用Flag后缀，例如应该使用IsDeleted,而不要使用DeleteFlag  
   
**集合命名**

\- 名称应该为名词及名词短语  
\- 使用Pascal规则  
\- 名称后面追加“Collection”

（个人觉得代表集合的类后面加Collection,代表集合的变量后面加List）  
   
**事件命名**

\- event handlers命名使用 EventHandler 后缀  
\- 两个参数分别使用 sender 及 e  
\- 使用Pascal规则  
\- 事件参数使用EventArgs 后缀  
\- 事件命名使用语法时态反映其激发的状态，例如 Changed，Changing  
\- 考虑使用动词命名. 变量命名

**其它常用的编码规则 **

\- 代码的缩进。要用Tab，而不要用space  
\- 局部变量的名称要有意义。不要用x，y，z等等（除用于For循环变量中可使用i，j，k，l，m，n）  
\- 所有的成员变量声明在类的顶端，用一个换行把它和方法分开  
\- 用有意义的名字命名namespace，如：产品名、公司名  
\- 把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用\#region…\#endregion

**自定义的属性以Attribute结尾**

public class AuthorAttribute : Attribute

自定义的异常以Exception结尾

public class AppException : Exception

**命名规范的总结用表格表示如下：**

与类相关：

<table> 
 <tbody> 
 <tr> 
 <td>标识符</td> 
 <td>大小写</td> 
 <td>示例</td> 
 </tr> 
 <tr> 
 <td>类/结构</td> 
 <td>Pascal</td> 
 <td>AppDomain</td> 
 </tr> 
 <tr> 
 <td>枚举类型</td> 
 <td>Pascal</td> 
 <td>ErrorLevel</td> 
 </tr> 
 <tr> 
 <td>枚举值</td> 
 <td>Pascal</td> 
 <td>FatalError</td> 
 </tr> 
 <tr> 
 <td>事件</td> 
 <td>&nbsp;Pascal&nbsp;</td> 
 <td>ValueChange</td> 
 </tr> 
 <tr> 
 <td>异常类</td> 
 <td>Pascal</td> 
 <td>WebException注意&nbsp;总是以 Exception 后缀结尾。</td> 
 </tr> 
 <tr> 
 <td>只读的静态字段</td> 
 <td>Pascal</td> 
 <td>RedValue</td> 
 </tr> 
 <tr> 
 <td>接口</td> 
 <td>Pascal</td> 
 <td>IDisposable注意&nbsp;总是以 I 前缀开始。</td> 
 </tr> 
 <tr> 
 <td>集合</td> 
 <td>Pascal</td> 
 <td>CustomerCollection 注意 总是以Collection结束</td> 
 </tr> 
 <tr> 
 <td>方法</td> 
 <td>Pascal</td> 
 <td>ToString</td> 
 </tr> 
 <tr> 
 <td>命名空间</td> 
 <td>Pascal</td> 
 <td>System.Drawing</td> 
 </tr> 
 <tr> 
 <td>参数</td> 
 <td>Camel</td> 
 <td>typeName</td> 
 </tr> 
 <tr> 
 <td>属性</td> 
 <td>Pascal</td> 
 <td>BackColor</td> 
 </tr> 
 <tr> 
 <td>受保护的实例字段</td> 
 <td>Camel</td> 
 <td>redValue注意&nbsp;很少使用。属性优于使用受保护的实例字段。</td> 
 </tr> 
 <tr> 
 <td>公共实例字段</td> 
 <td>Pascal</td> 
 <td>RedValue注意&nbsp;很少使用。属性优于使用公共实例字段。</td> 
 </tr> 
 </tbody> 
</table>

与变量命名相关（根据不同的数据类型前缀\+首字母大写的变量描述）

<table> 
 <tbody> 
 <tr> 
 <td>类型</td> 
 <td>前缀</td> 
 <td>示例</td> 
 </tr> 
 <tr> 
 <td>Array</td> 
 <td>arr</td> 
 <td>arrShoppingList</td> 
 </tr> 
 <tr> 
 <td>Boolean</td> 
 <td>bln</td> 
 <td>blnIsPostBack</td> 
 </tr> 
 <tr> 
 <td>Byte</td> 
 <td>byt</td> 
 <td>bytPixelValue</td> 
 </tr> 
 <tr> 
 <td>Char</td> 
 <td>chr</td> 
 <td>chrDelimiter</td> 
 </tr> 
 <tr> 
 <td>DateTime</td> 
 <td>dtm</td> 
 <td>dtmStartDate</td> 
 </tr> 
 <tr> 
 <td>Decimal</td> 
 <td>dec</td> 
 <td>decAverageHeight</td> 
 </tr> 
 <tr> 
 <td>Double</td> 
 <td>dbl</td> 
 <td>dblSizeofUniverse</td> 
 </tr> 
 <tr> 
 <td>Integer</td> 
 <td>int</td> 
 <td>intRowCounter</td> 
 </tr> 
 <tr> 
 <td>Long</td> 
 <td>lng</td> 
 <td>lngBillGatesIncome</td> 
 </tr> 
 <tr> 
 <td>Object</td> 
 <td>obj</td> 
 <td>objReturnValue</td> 
 </tr> 
 <tr> 
 <td>Short</td> 
 <td>shr</td> 
 <td>shrAverage</td> 
 </tr> 
 <tr> 
 <td>Single</td> 
 <td>sng</td> 
 <td>sngMaximum</td> 
 </tr> 
 <tr> 
 <td>String</td> 
 <td>str</td> 
 <td>strFirstName</td> 
 </tr> 
 </tbody> 
</table>

与ADO.NET有关

<table> 
 <tbody> 
 <tr> 
 <td>数据类型</td> 
 <td>数据类型简写</td> 
 <td>标准命名举例</td> 
 </tr> 
 <tr> 
 <td>Connection</td> 
 <td>con</td> 
 <td>conNorthwind</td> 
 </tr> 
 <tr> 
 <td>Command</td> 
 <td>cmd</td> 
 <td>cmdReturnProducts</td> 
 </tr> 
 <tr> 
 <td>Parameter</td> 
 <td>parm</td> 
 <td>parmProductID</td> 
 </tr> 
 <tr> 
 <td>DataAdapter</td> 
 <td>dad</td> 
 <td>dadProducts</td> 
 </tr> 
 <tr> 
 <td>DataReader</td> 
 <td>dtr</td> 
 <td>dtrProducts</td> 
 </tr> 
 <tr> 
 <td>DataSet</td> 
 <td>dst</td> 
 <td>dstNorthWind</td> 
 </tr> 
 <tr> 
 <td>DataTable</td> 
 <td>dtbl</td> 
 <td>dtblProduct</td> 
 </tr> 
 <tr> 
 <td>DataRow</td> 
 <td>drow</td> 
 <td>drowRow98</td> 
 </tr> 
 <tr> 
 <td>DataColumn</td> 
 <td>dcol</td> 
 <td>dcolProductID</td> 
 </tr> 
 <tr> 
 <td>DataRelation</td> 
 <td>drel</td> 
 <td>drelMasterDetail</td> 
 </tr> 
 <tr> 
 <td>DataView</td> 
 <td>dvw</td> 
 <td>dvwFilteredProducts</td> 
 </tr> 
 </tbody> 
</table>

与页面控件有关(html标签)

<table> 
 <tbody> 
 <tr> 
 <td>数据类型</td> 
 <td>数据类型简写</td> 
 <td>标准命名举例</td> 
 </tr> 
 <tr> 
 <td>Label</td> 
 <td>lbl</td> 
 <td>lblMessage</td> 
 </tr> 
 <tr> 
 <td>LinkLabel</td> 
 <td>llbl</td> 
 <td>llblToday</td> 
 </tr> 
 <tr> 
 <td>Button</td> 
 <td>btn</td> 
 <td>btnSave</td> 
 </tr> 
 <tr> 
 <td>TextBox</td> 
 <td>txt</td> 
 <td>txtName</td> 
 </tr> 
 <tr> 
 <td>MainMenu</td> 
 <td>mmnu</td> 
 <td>mmnuFile</td> 
 </tr> 
 <tr> 
 <td>CheckBox</td> 
 <td>chk</td> 
 <td>chkStock</td> 
 </tr> 
 <tr> 
 <td>RadioButton</td> 
 <td>rbtn</td> 
 <td>rbtnSelected</td> 
 </tr> 
 <tr> 
 <td>GroupBox</td> 
 <td>gbx</td> 
 <td>gbxMain</td> 
 </tr> 
 <tr> 
 <td>PictureBox</td> 
 <td>pic</td> 
 <td>picImage</td> 
 </tr> 
 <tr> 
 <td>Panel</td> 
 <td>pnl</td> 
 <td>pnlBody</td> 
 </tr> 
 <tr> 
 <td>DataGrid</td> 
 <td>dgrd</td> 
 <td>dgrdView</td> 
 </tr> 
 <tr> 
 <td>ListBox</td> 
 <td>lst</td> 
 <td>lstProducts</td> 
 </tr> 
 <tr> 
 <td>CheckedListBox</td> 
 <td>clst</td> 
 <td>clstChecked</td> 
 </tr> 
 <tr> 
 <td>ComboBox</td> 
 <td>cbo</td> 
 <td>cboMenu</td> 
 </tr> 
 <tr> 
 <td>ListView</td> 
 <td>lvw</td> 
 <td>lvwBrowser</td> 
 </tr> 
 <tr> 
 <td>TreeView</td> 
 <td>tvw</td> 
 <td>tvwType</td> 
 </tr> 
 <tr> 
 <td>TabControl</td> 
 <td>tctl</td> 
 <td>tctlSelected</td> 
 </tr> 
 <tr> 
 <td>DateTimePicker</td> 
 <td>dtp</td> 
 <td>dtpStartDate</td> 
 </tr> 
 <tr> 
 <td>HscrollBar</td> 
 <td>hsb</td> 
 <td>hsbImage</td> 
 </tr> 
 <tr> 
 <td>VscrollBar</td> 
 <td>vsb</td> 
 <td>vsbImage</td> 
 </tr> 
 <tr> 
 <td>Timer</td> 
 <td>tmr</td> 
 <td>tmrCount</td> 
 </tr> 
 <tr> 
 <td>ImageList</td> 
 <td>ilst</td> 
 <td>ilstImage</td> 
 </tr> 
 <tr> 
 <td>ToolBar</td> 
 <td>tlb</td> 
 <td>tlbManage</td> 
 </tr> 
 <tr> 
 <td>StatusBar</td> 
 <td>stb</td> 
 <td>stbFootPrint</td> 
 </tr> 
 <tr> 
 <td>OpenFileDialog</td> 
 <td>odlg</td> 
 <td>odlgFile</td> 
 </tr> 
 <tr> 
 <td>SaveFileDialog</td> 
 <td>sdlg</td> 
 <td>sdlgSave</td> 
 </tr> 
 <tr> 
 <td>FoldBrowserDialog</td> 
 <td>fbdlg</td> 
 <td>fgdlgBrowser</td> 
 </tr> 
 <tr> 
 <td>FontDialog</td> 
 <td>fdlg</td> 
 <td>fdlgFoot</td> 
 </tr> 
 <tr> 
 <td>ColorDialog</td> 
 <td>cdlg</td> 
 <td>cdlgColor</td> 
 </tr> 
 <tr> 
 <td>PrintDialog</td> 
 <td>pdlg</td> 
 <td>pdlgPrint</td> 
 </tr> 
 </tbody> 
</table>

与页面控件有关(html标签)

<table> 
 <tbody> 
 <tr> 
 <td>数据类型</td> 
 <td>简写</td> 
 <td>举例</td> 
 </tr> 
 <tr> 
 <td>AdRotator</td> 
 <td>adrt</td> 
 <td>Example</td> 
 </tr> 
 <tr> 
 <td>Button</td> 
 <td>btn</td> 
 <td>btnSubmit</td> 
 </tr> 
 <tr> 
 <td>Calendar</td> 
 <td>cal</td> 
 <td>calMettingDates</td> 
 </tr> 
 <tr> 
 <td>CheckBox</td> 
 <td>chk</td> 
 <td>chkBlue</td> 
 </tr> 
 <tr> 
 <td>CheckBoxList</td> 
 <td>chkl</td> 
 <td>chklFavColors</td> 
 </tr> 
 <tr> 
 <td>CompareValidator</td> 
 <td>valc</td> 
 <td>valcValidAge</td> 
 </tr> 
 <tr> 
 <td>CustomValidator</td> 
 <td>valx</td> 
 <td>valxDBCheck</td> 
 </tr> 
 <tr> 
 <td>DataGrid</td> 
 <td>dgrd</td> 
 <td>dgrdTitles</td> 
 </tr> 
 <tr> 
 <td>DataList</td> 
 <td>dlst</td> 
 <td>dlstTitles</td> 
 </tr> 
 <tr> 
 <td>DropDownList</td> 
 <td>drop</td> 
 <td>dropCountries</td> 
 </tr> 
 <tr> 
 <td>HyperLink</td> 
 <td>lnk</td> 
 <td>lnkDetails</td> 
 </tr> 
 <tr> 
 <td>Image</td> 
 <td>img</td> 
 <td>imgAuntBetty</td> 
 </tr> 
 <tr> 
 <td>ImageButton</td> 
 <td>ibtn</td> 
 <td>ibtnSubmit</td> 
 </tr> 
 <tr> 
 <td>Label</td> 
 <td>lbl</td> 
 <td>lblResults</td> 
 </tr> 
 <tr> 
 <td>LinkButton</td> 
 <td>lbtn</td> 
 <td>lbtnSubmit</td> 
 </tr> 
 <tr> 
 <td>ListBox</td> 
 <td>lst</td> 
 <td>lstCountries</td> 
 </tr> 
 <tr> 
 <td>Panel</td> 
 <td>pnl</td> 
 <td>pnlForm2</td> 
 </tr> 
 <tr> 
 <td>PlaceHolder</td> 
 <td>plh</td> 
 <td>plhFormContents</td> 
 </tr> 
 <tr> 
 <td>RadioButton</td> 
 <td>rad</td> 
 <td>radFemale</td> 
 </tr> 
 <tr> 
 <td>RadioButtonList</td> 
 <td>radl</td> 
 <td>radlGender</td> 
 </tr> 
 <tr> 
 <td>RangeValidator</td> 
 <td>valg</td> 
 <td>valgAge</td> 
 </tr> 
 <tr> 
 <td>Regularexpression_r</td> 
 <td>vale</td> 
 <td>valeEmail_Validator</td> 
 </tr> 
 <tr> 
 <td>Repeater</td> 
 <td>rpt</td> 
 <td>rptQueryResults</td> 
 </tr> 
 <tr> 
 <td>RequiredFieldValidator</td> 
 <td>valr</td> 
 <td>valrFirstName</td> 
 </tr> 
 <tr> 
 <td>Table</td> 
 <td>tbl</td> 
 <td>tblCountryCodes</td> 
 </tr> 
 <tr> 
 <td>TableCell</td> 
 <td>tblc</td> 
 <td>tblcGermany</td> 
 </tr> 
 <tr> 
 <td>TableRow</td> 
 <td>tblr</td> 
 <td>tblrCountry</td> 
 </tr> 
 <tr> 
 <td>TextBox</td> 
 <td>txt</td> 
 <td>txtFirstName</td> 
 </tr> 
 <tr> 
 <td>ValidationSummary</td> 
 <td>vals</td> 
 <td>valsFormErrors</td> 
 </tr> 
 <tr> 
 <td>XML</td> 
 <td>xmlc</td> 
 <td>xmlcTransformResults</td> 
 </tr> 
 </tbody> 
</table>