谁有C#的命名规范

Posted 2023-04-27

我在做作业的时候经常要用到C#的命名规范，我自己又不知道，哪位知道的能告诉我吗？
我的意思是希望回答的内容是这样的
text txt
Button btn

C# 编码规范和编程好习惯
命名惯例和规范

注记 :
Pascal 大小写形式－所有单词第一个字母大写，其他字母小写。
Camel 大小写形式－除了第一个单词，所有单词第一个字母大写，其他字母小写。

类名使用Pascal 大小写形式 public class HelloWorld ...

方法使用Pascal 大小写形式 public class HelloWorld void SayHello(string name) ...

变量和方法参数使用Camel 大小写形式

public class HelloWorld int totalCount = 0; void SayHello(string name) string fullMessage = "Hello " + name; ...

不要使用匈牙利方法来命名变量

以前，多数程序员喜欢它－把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如： string m_sName;int nAge;
然而，这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式，而不是用数据类型和m_来作前缀。

用有意义的，描述性的词语来命名变量

- 别用缩写。用name, address, salary等代替 nam, addr, sal
- 别使用单个字母的变量象i, n, x 等. 使用 index, temp等
用于循环迭代的变量例外： for ( int i = 0; i < count; i++ ) ...
如果变量只用于迭代计数，没有在循环的其他地方出现，许多人还是喜欢用单个字母的变量(i) ，而不是另外取名。
- 变量名中不使用下划线 (_) 。
- 命名空间需按照标准的模式命名
...

文件名要和类名匹配

例如，对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb) 缩进和间隔
缩进用 TAB . 不用 SPACES.。
注释需和代码对齐.。
花括弧 ( ) 需和括号外的代码对齐.。
用一个空行来分开代码的逻辑分组。.
bool SayHello (string name) string fullMessage = "Hello " + name; DateTime currentTime = DateTime.Now; string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString(); MessageBox.Show ( message ); if ( ... ) // Do something // ... return false; return true;
这段代码看起来比上面的好：: bool SayHello ( string name ) string fullMessage = "Hello " + name; DateTime currentTime = DateTime.Now;
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( message );
if ( ... ) // Do something // ...
return false;
return true;

在一个类中，各个方法需用一空行，也只能是一行分开。
花括弧需独立一行，而不象if, for 等可以跟括号在同一行。.
好： if ( ... ) // Do something
不好： if ( ... ) // Do something

在每个运算符和括号的前后都空一格。.

好： if ( showResult == true ) for ( int i = 0; i < 10; i++ ) //
不好： if(showResult==true) for(int i= 0;i<10;i++) //
良好的编程习惯
遵从以下良好的习惯以写出好程序

避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。

好： void SavePhoneNumber ( string phoneNumber ) // Save the phone number.

不好： // This method will save the phone number. void SaveData ( string phoneNumber ) // Save the phone number.

一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。

好： // Save the address. SaveAddress ( address ); // Send an email to the supervisor to inform that the address is updated. SendEmail ( address, email ); void SaveAddress ( string address ) // Save the address. // ... void SendEmail ( string address, string email ) // Send an email to inform the supervisor that the address is changed. // ...

不好： // Save address and send an email to the supervisor to inform that the address is updated. SaveAddress ( address, email ); void SaveAddress ( string address, string email ) // Job 1. // Save the address. // ... // Job 2. // Send an email to inform the supervisor that the address is changed. // ...

使用C# 或 VB.NET的特有类型，而不是System命名空间中定义的别名类型。

好： int age; string name; object contactInfo;

不好： Int16 age; String name; Object contactInfo;

别在程序中使用固定数值，用常量代替。
别用字符串常数。用资源文件。
避免使用很多成员变量。声明局部变量，并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量，那就很难知道是哪个方法在什么时候修改了它的值。
必要时使用enum 。别用数字或字符串来指示离散值。
好： enum MailType html, PlainText, Attachment void SendMail (string message, MailType mailType) switch ( mailType ) case MailType.Html: // Do something break; case MailType.PlainText: // Do something break; case MailType.Attachment: // Do something break; default: // Do something break;

不好： void SendMail (string message, string mailType) switch ( mailType ) case "Html": // Do something break; case "PlainText": // Do something break; case "Attachment": // Do something break; default: // Do something break;

别把成员变量声明为 public 或 protected。都声明为 private 而使用 public/protected 的Properties.
不在代码中使用具体的路径和驱动器名。 使用相对路径，并使路径可编程。
永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。
应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。
如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。
如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。
错误消息需能帮助用户解决问题。永远别用象"应用程序出错", "发现一个错误" 等错误消息。而应给出象 "更新数据库失败。请确保登陆id和密码正确。" 的具体消息。
显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用 象 "更新数据库失败。"这样的，要提示用户怎么做："更新数据库失败。请确保登陆id和密码正确。"
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。 注释
别每行代码，每个声明的变量都做注释。
在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。
行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。
如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。
对一个数值变量采用不是0,-1等的数值初始化，给出选择该值的理由。
简言之，要写清晰，可读的代码以致无须什么注释就能理解。
对注释做拼写检查，保证语法和标点符号的正确使用。
异常处理
不要“捕捉了异常却什么也不做“。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。
发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。
只捕捉特定的异常，而不是一般的异常。

好： void ReadFromFile ( string fileName ) try // read from file. catch (FileIOException ex) // log error. // re-throw exception depending on your case. throw;
不好： void ReadFromFile ( string fileName ) try // read from file. catch (Exception ex) // Catching general exception is bad... we will never know whether it // was a file error or some other error. // Here you are hiding an exception. // In this case no one will ever know that an exception happened. return "";

不必在所有方法中捕捉一般异常。不管它，让程序崩溃。这将帮助你在开发周期发现大多数的错误。
你可以用应用程序级（线程级）错误处理器处理所有一般的异常。遇到”以外的一般性错误“时，此错误处理器应该捕捉异常，给用户提示消息，在应用程序关闭或 用户选择”忽略并继续“之前记录错误信息。
不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如，当你写文件时，处理异常FileIOException.
别写太大的 try-catch 模块。如果需要，为每个执行的任务编写单独的 try-catch 模块。 这将帮你找出哪一段代码产生异常，并给用户发出特定的错误消息
如果应用程序需要，可以编写自己的异常类。自定义异常不应从基类SystemException派生，而要继承于. IApplicationException。

参考资料：http://user.qzone.qq.com/2743385/blog/1223205074

参考技术A C#的命名规范
1、命名约定
Pascal和Camel命名约定

编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType；Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）

以下是一些常用的C#成员及其推荐命名方法：

标志符
规则
实例与描述

类class
Pascal
Application

枚举类型enum
Pascal
记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue

委托delegate
Pascal
以Pascal命名，不以任何特殊字符串区别于类名、函数名

常量const
全部大写
全部大写，单词间以下划线隔开

接口interface
Pascal
IDisposable 注：总是以 I 前缀开始，后接Pascal命名

方法function
Pascal
ToString

命名空间namespace
Pascal
以.分隔，当每一个限定词均为Pascal命名方式，比如：

using ExcelQuicker.Framework

参数
Camel
首字母小写

局部变量
Camel
也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty;

数据成员
Camel
以m开头＋Pascal命名规则，如mProductType（m意味member）

属性
Pascal 参考技术B 在网上搜索有很多,可以去msdn上面去找

基本上微软的命名规范是这样的:

类型简写+你自己的变量名(一般遵循正常大小写)

比如 一个名为name的textbox那么写出来就是tbName或者是txtName
一个名为url的string那么写出来就是strURL

其实所谓的命名规范都是为了能够让自己的代码更清晰。所以可以自己去慢慢掌握这个“度”

一楼的兄弟给的就很全面，可以去他给的那个 网页看看，我们可以参考微软的命名规范，不过没有必要完全模仿。

参考资料：http://syw970212.spaces.live.com/Blog/cns!BB8DCF420E6BA803!345.entry

参考技术C 1.用Pascal规则来命名方法和类型。
public class DataGrid

public void DataBind()





2.用Camel规则来命名局部变量和方法的参数.
public class Product

private string _productId;
private string _productName;

public void AddProduct(string productId,string productName)





3.所有的成员变量前加前缀“_”。
public class DataBase

private string _connectionString;


4.接口的名称加前缀 “I”。
public interface IConvertible

byte ToByte();


5.自定义的属性以“Attribute”结尾。
public class TableAttribute:Attribute




6.自定义的异常以Exception结尾。
public class NullEmptyException:Exception




7.方法的命名。一般将其命名为动宾短语。
public class File

public void CreateFile(string filePath)



public void GetPath(string path)





8．局部变量的名称要有意义。
不要用x，y，z等等，用For循环变量中可使用i, j, k, l, m, n。
public class User

public void GetUser()

string[] userIds=;

for(int i=0,k=userIds.Length;i<k;i++)






9．所有的成员变量声明在类的顶端，用一个换行把它和方法分开。
public class Product

private string _productId;
private string _productName;

public void AddProduct(string productId,string productName)





10．用有意义的名字命名namespace，如：公司名、产品名。
namespace Zivsoft//公司命名



namespace ERP//产品命名




11．建议局部变量在最接近使用它时再声明。

12．使用某个控件的值时，尽量命名局部变量。
public string GetTitle()

string title=lbl_Title.Text;
return title;


14.把引用的系统的namespace和自定义或第三方的用一个换行把它们分开。
using System;
using System.Web.UI;
using System.Windows.Forms;

using CSharpCode;
using CSharpCode.Style;

15.文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类。

16.目录结构中要反应出namespace的层次。

17.大括号""要新起一行。
public Sample()

//
// TODO: 在此处添加构造函数逻辑
//
参考技术D //全套在这

数据类型 数据类型简写 标准命名举例
Array arr arrShoppingList
Boolean bln blnIsPostBack
Byte byt bytPixelValue
Char chr chrDelimiter
DateTime dtm dtmStartDate
Decimal dec decAverageHeight
Double dbl dblSizeofUniverse
Integer int intRowCounter
Long lng lngBillGatesIncome
Object obj objReturnValue
Short shr shrAverage
Single sng sngMaximum
String str strFirstName

控件类型 缩写 示例
Animated button ani aniMailBox
Button btn
Check box chk chkReadOnly
ColorDialog clrdlg
Combobox,drop-down list box cbo cboEnglish
Communications com comFax
ContextMenu ctxmnu
Control(used within procedures when the specific type is unknown) ctr ctrCurrent
CrystalReportViewer crvw
Data dat datBiblio
Data grid dgd dgdTitles
Data list dbl dblPublisher
Data repeater drp drpLocation
Data-bound combo box dbcbo dbcboLanguage
Data-bound grid dbgrd dbgrdQueryResult
Data-bound list box dblst dblstJobType
Datetime picker dtp dtpPublished
Directory list box dir dirSource
DomainUpDown dupd
Drive list box drv drvTarget
ErrorProvider err
File list box fil filSource
Flat scroll bar fsb fsbMove
FontDialog fntdlg
Form frm frmEntry
Frame fra fraLanguage
Gauge gau gauStatus
Graph gra graRevenue
Grid grd grdPrices
GroupBox grp
HelpProvider hlp
Hierarchical flexgrid flex flexOrders
HScroll bar hsb hsbVolume
Image img imgIcon
Image combo imgcbo imgcboProduct
ImageList ils ilsAllIcons
Label lbl lblHelpMessage
Line lin linVertical
LinkLabel lnk
List box lst lstPolicyCodes
ListView lvw lvwHeadings
MAPI message mpm mpmSentMessage
MAPI session mps mpsSession
MCI mci mciVideo
Menu mnu mnuFileOpen
Month view mvw mvwPeriod
MonthCalendar mcl
MS Chart ch chSalesbyRegion
MS Flex grid msg msgClients
MS Tab mst mstFirst
NotifyIcon nti
NumericUpDown nupd
OLE container ole oleWorksheet
OpenFileDialog ofdlg
PageSetUpDialog psdlg
Picture box pic picVGA
Picture clip clp clpToolbar
PrintDocument prndoc
PrintPreviewControl ppctl
PrintPreviewDialog ppdlg
ProgressBar prg prgLoadFile
RadioButton rbtn
Remote Data rd rdTitles
RichTextBox rtf rtfReport
SaveFileDialog sfdlg
Shape shp shpCircle
Slider sld sldScale
Spin spn spnPages
Splitter spt
StatusBar sta staDateTime
SysInfo sys sysMonitor
TabContrl tab
TabStrip tab tabOptions
Text box txt txtLastName
Timer tmr tmrAlarm
Toolbar tlb tlbActions
TrackBar trb
TreeView tre treOrganization
UpDown upd updDirection
VScroll bar vsb vsbRate

1 ADO.NET 命名规范 数据类型 数据类型简写 标准命名举例
Connection con conNorthwind
Command cmd cmdReturnProducts
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

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

3 WebControl 命名规范
数据类型 数据类型简写 标准命名举例
AdRotator adrt Example
Button btn btnSubmit
Calendar cal calMettingDates
CheckBox chk chkBlue
CheckBoxList chkl chklFavColors
CompareValidator valc valcValidAge
CustomValidator 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

C#的winform控件命名规范

注：这里用红字标记的部分表示有重复出现，括号内为替代表示方案

1.标准控件

 

序号	控件类型简写	控件类型
1	btn	Button
2	chk	CheckBox
3	ckl	CheckedListBox
4	cmb	ComboBox
5	dtp	DateTimePicker
6	lbl	Label
7	llb	LinkLabel
8	lst	ListBox
9	lvw	ListView
10	mtx	MaskedTextBox
11	cdr	MonthCalendar
12	icn	NotifyIcon
13	nud	NumeircUpDown
14	pic	PictureBox
15	prg(pgb)	ProgressBar
16	rdo	RadioButton
17	rtx	RichTextBox
18	txt	TextBox
19	tip	ToolTip
20	tvw	TreeView
21	wbs	WebBrowser

 

 

2.容器控件

 

序号	控件类型简写	控件类型
1	flp	FlowLayoutPanel
2	grp	GroupBox
3	pnl	Panel
4	spl(spc)	SplitContainer
5	tab	TabControl
6	tlp	TableLayoutPanel

 

 

3.菜单和工具栏

 

序号	控件类型简写	控件类型
1	cms	ContextMenuStrip
2	mns	MenuStrip
3	ssr	StatusStrip
4	tsr	ToolStrip
5	tsc	ToolStripContainer

 

 

4.数据

 

序号	控件类型简写	控件类型
1	dts	DataSet
2	dgv	DataGridView
3	bds	BindingSource
4	bdn	BindingNavigator
5	rpv	ReportViewer

 

 

5.对话框

 

序号	控件类型简写	控件类型
1	cld	ColorDialog
2	fbd	FolderBrowserDialog
3	fnd	FontDialog
4	ofd	OpenFileDialog
5	sfd	SaveFileDialog

 

 

6.组件

 

序号	控件类型简写	控件类型
1	bgw	BackgroundWorker
2	dre	DirectoryEntry
3	drs	DirectorySearcher
4	err	ErrorProvider
5	evl	EventLog
6	fsw	FileSystemWatcher
7	hlp	HelpProvider
8	img	ImageList
9	msq	MessageQueue
10	pfc	PerformanceCounter
11	prc	Process
12	spt	SerialPort
13	scl	ServiceController
14	tmr	Timer

 

 

7.印刷

 

序号	控件类型简写	控件类型
1	psd	PageSetupDialog
2	prd	PrintDialog
3	pdc	PrintDocument
4	prv	PrintPreviewControl
5	ppd	PrintPreviewDialog

 

 

8.水晶报表

 

序号	控件类型简写	控件类型
1	crv	CrystalReportViewer
2	rpd	ReportDocument

 

 

9.其他

 

序号	控件类型简写	控件类型
1	dud	DomainUpDown
2	hsc	HScrollBar
3	prg	PropertyGrid
4	spl	Splitter
5	trb	TrackBar
6	vsc	VScrollBar

 

另一个版本

 

序号	控件类型	控件类型简写	标准命名举例
1	Label	lbl	lblMessage
2	LinkLabel	llbl	llblToday
3	Button	btn	btnSave
4	TextBox	txt	txtName
5	MainMenu	mmnu	mmnuFile
6	CheckBox	chk	chkStock
7	RadioButton	rbtn	rbtnSelected
8	GroupBox	gbx	gbxMain
9	PictureBox	pic	picImage
10	Panel	pnl	pnlBody
11	DataGrid	dgrd	dgrdView
12	ListBox	lst	lstProducts
13	CheckedListBox	clst	clstChecked
14	ComboBox	cbo	cboMenu
15	ListView	lvw	lvwBrowser
16	TreeView	tvw	tvwType
17	TabControl	tctl	tctlSelected
18	DateTimePicker	dtp	dtpStartDate
19	HscrollBar	hsb	hsbImage
20	VscrollBar	vsb	vsbImage
21	Timer	tmr	tmrCount
22	ImageList	ilst	ilstImage
23	ToolBar	tlb	tlbManage
24	StatusBar	stb	stbFootPrint
25	OpenFileDialog	odlg	odlgFile
26	SaveFileDialog	sdlg	sdlgSave
27	FolderBrowserDialog	fbdlg	fgdlgBrowser
28	FontDialog	fdlg	fdlgFoot
29	ColorDialog	cdlg	cdlgColor
30	PrintDialog	pdlg	pdlgPrint