C#命名规范Word文件下载.docx
《C#命名规范Word文件下载.docx》由会员分享,可在线阅读,更多相关《C#命名规范Word文件下载.docx(9页珍藏版)》请在冰豆网上搜索。
DotNet解决方案、DotNet项目、DotNet专属文件、文件夹均使用Pascal风格。
文件扩展名、js文件名、css文件名、图片文件名均使用Camel风格。
5C#控件命名规范
●DataControl
类型
前缀
示例
AccessDataSource
ads
adsPubs
DataList
dlst
dlstTitles
DetailView
dvw
dvwTitles
FormView
fvw
fvwFonts
GridView
gvw
gvwCity
ObjectDataSource
ods
odsMenus
Repeater
rpt
rptQueryResults
ReportViewer
rvw
rvwRecord
SiteMapDataSource
smds
smdsSite
SqlDataSource
sds
sdsBooks
XmlDataSource
xds
xdsTitles
●ValidationControl
CompareValidator
valc
valcValidAge
CustomValidator
valx
valxDBCheck
RangeValidator
valg
valgAge
RegularExpressionValidator
vale
valeEmail
RequiredFieldValidator
valr
valrFirstName
ValidationSummary
vals
valsFormErrors
●NavigationControl
Menu
mnu
mnuUser1
SiteMapPath
smp
smpSite1
TreeView
trvw
trvwMenu
●LoginControl
ChangePassword
cpwd
cpwdUser1
CreateUserWizard
cuw
cuwLogin
Login
log
logCenter
LoginName
logn
lognUser
LoginStatus
logs
logsUser
LoginView
logv
logvUser
PasswordRecovery
pwdr
pwdrUser
●WebPartsControl
AppearanceEditorPart
paed
paedPart1
BehaviorEditorPart
pbed
pbedPart2
CatalogZone
zca
zcatCity
ConnectionsZone
zcon
zconDataBase
DeclarativeCatalogPart
pdca
pdcaPart1
EditorZone
zed
zedNews
ImportCatalogPart
pica
picaPart
LayoutEditorPart
pled
pledNews
PageCatalogPart
ppca
ppcaMail
PropertyGridEditorPart
ppge
ppgeServer
ProxyWebPartManager
mpwp
mpwpWeb
WebPartManager
mwp
mwpSite1
WebPartZone
zwp
zwpSite2
●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
dvwFilteredProducts
●WinFormControl命名规范
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
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
●WebControl命名规范
Adrotator
adrt
adrtTopAd
BulletedList
blst
blstCity
btnSubmit
Calendar
cal
calMettingDates
chkBlue
CheckBoxList
chkl
chklFavColors
DropDownList
drop
dropCountries
dgrdTitles
FileUpLoad
fup
fupImage
HiddenField
hfld
hfldName
HyperLink
hlk
hlkDetails
Image
img
imgAuntBetty
ImageButton
ibtn
ibtnSubmit
ImageMap
imap
imapSite
lblResults
LinkButton
lbtn
lbtnSubmit
lstCountries
Literal
ltl
ltlTitle
Localize
loc
locChina
MultiView
mvw
mvwForm1
pnlForm2
PlaceHolder
plh
plhFormContents
rad
radFemale
RadioButtonList
radl
radlGender
RegularExpression
valeEmail_Validator
SubStitution
subs
subsTime
txtFirstName
Table
tbl
tblCountryCodes
TableCell
tblc
tblcGermany
TableRow
tblr
tblrCountry
View
vw
vwCity
Wizard
wiz
wizRegister
三、注释规范
文件头注释
/******************************************************************
*版权:
福建八达
*功能描述:
添加系统用户
*创建时间:
2009-7-27
*作者:
*版本:
*修订描述:
*最后修订日期:
******************************************************************/
四、编码准则
1避免过长的方法,方法体应该少于60行。
2避免使用诸如0,1,2之类的字面状态量,应该使用更有表达意义的const变量或枚举来取代。
3拒绝代码冗余,冗余是代码腐化的根源。
4坚持单一职责原则,一个类只因有一个变化的原因。
5缩进用TAB,不用SPACES。
6在每个运算符前后都空一格。
7花括弧({})需和括号外的代码对齐。
每个花括弧需独立一行。
8用一个空行来分开代码的逻辑分组。
9在一个类中,各个方法需用一空行,也只能是一行分开。
10注释需和代码对齐。
只在必需的地方注释。
行数不多的注释会使代码看起来优雅。
(前提是你的代码命名有意义和逻辑结构清晰)。
11如果应为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释。
12避免在同一个文件中放置多个类。
13避免使用大文件。
如果一个文件里的代码超过500行,必须考虑将代码分开到不同类中。
14总是使用接口。
避免只有一个成员的接口,努力保证一个接口有3~5个成员。
当使用抽象类的时候,提供一个接口。
15一个方法只完成一个任务。
不要把多个任务组合到一个方法中,即使那些任务非常小。
16避免写超过5个参数的方法。
如果要传递多个参数,使用结构。
17除了要在switch语句块中实现代码跳转,不要使用goto关键字。
18避免使用很多成员变量。
声明局部变量,并传递给方法。
不要在方法间共享成员变量。
否则很难知道是哪个方法在什么时候修改了它的值。
19在最靠近一个局部变量被使用的地方声明该局部变量。
20避免stringname=””;
正确stringname=String.Empty;
21异常处理
●错误消息而应给出具体错误消息和相应的用户需要做的操作。
●千万不要捕捉了异常却什么也不做。
异常信息要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。
●别写太大的try-catch模块。
如果需要,为每个执行的任务编写单独的try-catch模块。
这将帮你找出哪一段代码产生异常,并给用户发出特定的错误消息如果应用程序需要,可以编写自己的异常类。
对自定义的异常类加上后缀Exception。
●不必每个方法都用try-catch。
当特定的异常可能发生时才使用。
不必在所有方法中捕捉一般异常。
不管它,让程序崩溃。
这将帮助你在开发周期发现大多数的错误。
●数据库操作和文件操作时,finally很必要。