C#项目命名规范

命名规范制定意义

1 方便代码的交流和维护，便于日后自己的再次阅读。

2 不影响编码的效率，不与大众习惯冲突。

3 使代码更美观、阅读更方便。

4 使代码的逻辑更清晰、更易于理解

命名规范制定原则

首要原则

有意义的，描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了

1. 除约定俗成的，别用缩写。用name, address, salary等代替 nam, addr, sal

2. 除用于循环，别使用单个字母的变量象i, n, x 等. 而要使用 index, temp等。

for ( int i = 0; i < count; i++ ){ ...}

其他习惯

除了界面控件外，不要使用类型前缀。比如：使用名称amount，而不是 intAmount；

类：使用名词、名词短语命名。比如：public class FileStream；

方法：使用动词、动词短语开始。比如：CreateUser(), RemoveAt()等；

接口：以 I 开始，后面加上名词、名词短语、形容词命名。比如：IDisposable；

常量：所有单词大写，多个单词之间用 "_" 隔开。public const string PAGE_TITLE = "Welcome";

命名空间：基本格式：

CompanyName/ProjectName.TechnologyName[.Feature][.Design]

a) CompanyName/ProjectName：公司名、项目名称或产品名称；

b) TechnologyName：稳定的、公认的技术名称或架构层次名称；

c) [.Feature][.Design]：可选的功能与设计；

规范

1、用pascal规则来命名方法和类.(第一个单词首字母大写，后面连接的每个单词首字母都大写）

public class DataBase ；public void GetDataTable()

2、类：使用名词、名词短语命名。比如：public class FileStream；

2.用camel规则来命名局部变量和方法的参数. (第一个单词不大写，后面连接的单词首字母大写)

public void AddUser(string userId, byte[] password)

{ string userName;}

3.所有的成员变量前加前缀 _

public class Database

{ private string _connectionString; }

4.接口的名称加前缀 I

interface ICompare

{ int compare(); }

5.自定义代码属性类以Attribute结尾

public class OperationAttribute : Attribute

6.自定义的异常以Exception结尾

public class AppException : Exception

Array arr arrShoppingList

Boolean bln blnIsPostBack

Byte byt bytPixelValue

Char chr chrDelimiter DateTim e dt m dt m StartDate

Decimal dec decAverageHeight

Double dbl dblSizeofUniverse

Integer int int RowCounter

Long lng lngBillGatesIncom e

Object obj objReturnValue

Short shr shrAverage

Single sng sngMaximum

String str strFirstName WebControls

Type Prefix Example

AdRotator adrt adrtTopAd

Button btn btnSubmit

Calendar cal calMettingDates

CheckBox chk chkBlue

CheckBoxList chkl chklFavColors CompareValidator valc valcValidAge

Custom Validator valx valxDBCheck DataGrid dgrd dgrdTitles

DataList dlst dlstTitles DropDownList drop dropCountries

HyperLink lnk lnkDetails

Image img imgAuntBetty ImageButton ibtn ibtnSubmit Label lbl lblResults LinkButton lbtn lbtnSubmit

ListBox lst lstCountries

Panel pnl pnlForm2 PlaceHolder plh plhFormContents

RadioButton rad radFemale

RadioButtonList radl radlGender

RangeValidator valg valgAge

RegularExpression vale valeEmail_Validator Repeater rpt rptQueryResults RequiredFieldValidator valr valrFirstName Table tbl tblCountryCodes

TableCell tblc tblcGermany

TableRow tblr tblrCountry

TextBox txt txtFirstName ValidationSummary vals valsFormErrors

XML xmlc xmlcTransformResults

https://www.360docs.net/doc/65580419.html,

Type Prefix Example

Connection con conNorthwind

Command cm d cm dReturnProducts

Parameter parm parmProductID

DataAdapter dad dadProducts

DataReader dtr dtrProducts

DataSet dst dstNorthWind

DataTable dtbl dtblProduct

DataRow drow drowRow98

DataColumn dcol dcolProductID

DataRelation drel drelMasterDetail

DataView dvw dvwFilteredProducts

Event-Handling Subroutines

The name of an event-handling subroutine will consist of the ID of the control that rasied the event followed by the type of event being handled. For example, a subroutine named btnSubmit_Click handles the Click event of a Button control named btnSubmit.

When a control that raises an event is not assigned an ID, the type of the control is used instead of the ID. For example, the subroutine named Button_Click handles the Click event of a Button control wi thout an ID.

希望大家能够写出风格一致的代码。

(请您对文章做出评价)

C#控件命名规范

作者：Jacky.Zhou来源：博客园发布时间：2009-06-23 14:36 阅读：648 次原文链接[收藏]

Data Control

类型前缀示例

AccessDataSource ads adsPubs

Validation Control

Navigation Control

L ogin Control

WebParts Control

https://www.360docs.net/doc/65580419.html, 命名规范

WinForm Control 命名规范