C#代码开发命名规范示例.docx
- 文档编号:3117680
- 上传时间:2022-11-17
- 格式:DOCX
- 页数:14
- 大小:21.98KB
C#代码开发命名规范示例.docx
《C#代码开发命名规范示例.docx》由会员分享,可在线阅读,更多相关《C#代码开发命名规范示例.docx(14页珍藏版)》请在冰豆网上搜索。
C#代码开发命名规范示例
代码开发命名规范拟稿
该规范的制定致力于规范代码格式,提高开发效率,保证程序质量,最终解释权归*********软件开发组。
1.项目名称及类库命名规范
项目名称:
Testlatform,简写Test
实体类类库命名:
Test.Model
业务逻辑类类库命名:
Test.BLL
数据工厂类类库命名:
Test.DALFactory
数据库帮助类类库命名:
Test.DBUtility
数据接口类类库命名:
Test.IDAL
数据访问层类类库命名:
Test.SQLServerDAL
常用帮助类类库命名:
Test.Utils
表现层类库命名:
Test.UI
2.数据库名称及字段命名规范
1)数据库命名
数据库命名:
同项目名称简写(Test)
2)实体(表)命名
规则:
[前缀]_[表存储内容简称]
举例:
Sys_User【系统用户表】
Sys_Role【角色表】
3)属性(列)命名
规则:
[前缀]+[列存储内容简称]
举例:
UserID【用户编号】UserID
RoleName【角色名称】
4)视图命名:
规则:
视图以V作为前缀,其他命名规则和表的命名类似;
命名应尽量体现各视图的功能。
举例:
V_GetUserLogInfo【获取用户的登录信息】
5)触发器的命名
规则:
触发器以TR作为前缀,触发器名为相应的表名加上后缀,Insert触发器加"_I",Delete触发器加"_D",Update触发器加"_U",
举例:
TR_User_I【添加用户时激发】
6)存储过程命名
规则:
存储过程应以"UP_"开头,和系统的存储过程区分,后续部分以存储过程内容加存储过程的动作构成(参考动软代码生成器生成存储过程的规则),并用下划线分割各个组成部分。
举例:
UP_Sys_User_Update【更新系统用户信息】
7)变量命名
规则:
变量名采用小写,若属于词组形式,用下划线分隔每个单词,
举例:
@my_err_no。
8)命名中其他注意事项
a.以上命名都不得超过30个字符的系统限制。
变量名的长度限制为29(不包括标识字符@)。
b.数据对象、变量的命名都采用英文字符,禁止使用中文命名。
绝对不要在对象名的字符之间留空格。
c.小心保留词,要保证你的字段名没有和保留词、数据库系统或者常用访问方法冲突
d.保持字段名和类型的一致性,在命名字段并为其指定数据类型的时候一定要保证一致性。
假如数据类型在一个表里是整数,那在另一个表里可就别变成字符型了。
3.项目代码命名规范
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)WebControl命名规范
Web控件名
简写
标准命名举例
AdRotator
adrt
adrtExample
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
3)HTML控件命名规则
HTML控件名
简写
标准命名举例
HtmlAnchor
hah
hahUserDetial
HtmlButton
hbtn
hbtnConfirm
HtmlForm
hform
hformFromUser
HtmlGenericControl
hgc
HtmlImage
himg
himgHeader
HtmlInputButton(按钮)
hbbtn
hbbtnButton
HtmlInputButton(重置)
hrbtn
hrbtnReset
HtmlInputButton(提交)
hcbtn
hcbtnSubmit
HtmlInputCheckBox
hick
hickSelectAll
HtmlInputFile
hifile
hifileUploadFile
HtmlInputHidden
hihid
hihidUserID
HtmlInputImage
hiimg
hiimgUserUpdate
HtmlInputRadioButton
hirb
hirbSelectUser
HtmlInputText(密码)
hipwd
hipwdUserPass
HtmlInputText(文本)
hitxt
hitxtUserName
HtmlSelect
hslt
hsltUser
HtmlTable
htab
htabHeader
HtmlTableCell
htc
htcUserName
HtmlTableRow
htr
htrTitle
HtmlTextArea
htxta
htxtaNotes
4)常量、变量名及类名命名规范
a.常量命名
规则:
大写英文字母加下划线
举例:
PRICE,MARKET_PRICE
b.变量命名
变量类型
类型简写
标准命名举例
Array
arr
arrShoppingList
Boolean
bln
blnIsPostBack
Byte
byt
bytPixelValue
Char
chr
chrDelimiter
DateTime
dtm
dtmStartDate
Decimal
dec
decAverageHeight
Double
dbl
dblSizeofUniverse
Guid
gu
guUserID
Integer
int
intRowCounter
Long
lng
lngBillGatesIncome
Object
obj
objReturnValue
Short
shr
shrAverage
Single
sng
sngMaximum
String
str
strFirstName
c.类命名
1、类名命名:
以该类的具体用途命名该类类名,全英文构成,单个单词首字母大写,组合单词每个单词首字母大写,其它字母小写,例如:
UserInfo,ProductDetails。
2、顶级命名空间命名:
例如:
Test。
3、类库名空间命名:
“Test”+“.”+类库名,例如:
Test.BLL。
4、类名空间命名:
“Test”+“.”+类库名+类名,例如:
Test.Model.DeptInfo。
5)CSS命名规范
样式表文件名命名规则,全英文构成,单个单词首字母大写,组合单词每个单词首字母大写,其它字母小写,并以“Style”结尾,前面组合单词指明该样式表的用途,例如:
HomePageStyle,表示应用于主页的全局样式表;ProudctListStyle,表示应用于产品列表的样式表。
a.CSS常用命名规范
头:
header
内容:
content/container
尾:
footer
导航:
nav
侧栏:
sidebar
栏目:
column
页面外围控制整体布局宽度:
wrapper
左右中:
leftrightcenter
登录条:
loginbar
标志:
logo
广告:
banner
页面主体:
main
热点:
hot
新闻:
news
下载:
download
子导航:
subnav
菜单:
menu
子菜单:
submenu
搜索:
search
友情链接:
friendlink
页脚:
footer
版权:
copyright
滚动:
scroll
内容:
content
标签页:
tab
文章列表:
list
提示信息:
msg
小技巧:
tips
栏目标题:
title
加入:
joinus
指南:
guild
服务:
service
注册:
regsiter
状态:
status
投票:
vote
合作伙伴:
partner
b.注释的写法
/*Footer*/
内容区
/*EndFooter*/
c.id的命名
(1)页面结构
容器:
container
页头:
header
内容:
content/container
页面主体:
main
页尾:
footer
导航:
nav
侧栏:
sidebar
栏目:
column
页面外围控制整体布局宽度:
wrapper
左右中:
leftrightcenter
(2)导航
导航:
nav
主导航:
mainbav
子导航:
subnav
顶导航:
topnav
边导航:
sidebar
左导航:
leftsidebar
右导航:
rightsidebar
菜单:
menu
子菜单:
submenu
标题:
title
摘要:
summary
(3)功能
标志:
logo
广告
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- C# 代码 开发 命名 规范 示例