编码规范.docx
《编码规范.docx》由会员分享，可在线阅读，更多相关《编码规范.docx（15页珍藏版）》请在冰点文库上搜索。
编码规范
1.1.1.1编码规范
1.1.1.1.1C＃编码规范
1.1.1.1.1.1基本约定
●所有的命名名称都必须使用能直接体现具体含义的名字。
不能使用X，Y，Z，等无意义的名称进行定义，除循环变量除外。
●所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开
如:
publicclassClsLogin
{
TextBoxtxtUserName;//
TextBoxtxtPassWord;//
publicLogin（）
{
}
}
●类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类，文件和文件夹的名称也应该精确地说明它们的用途。
如：
文件名：
Login.cs
类名：
publicclassClsLogin
●大括号"{"要新起一行。
正确编写：
publicclassClsLogin
{
}
错误编写：
publicclassClsLogin{
}
●switch语句一定要有default来处理意外情况。
●同程序外部连接（如连接数据库、接口、文件等）一定要捕获任何类型的异常（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间，和相关方法，类名等。
●始终使用"{}"包含if/else下的语句，即使只有一条语句。
正确编写：
if（true）
{
//语句。
}
错误编写：
if（true）
//语句。
●把引用的系统的namespace和自定义或第三方的分开。
usingSystem;
usingSystem.Web;
usingSystem.Web.Security;
usingSystem.Web.UI;
usingSystem.Web.UI.WebControls;
usingMYNameSpace.NameSpace;
●不同函数或方法之间，需要用空行来分开。
如：
publicclassClsLogin
{
publicLogin（）
{
}
Public~Login（）
{
}
}
●不在代码中使用具体的路径和驱动器名，必须使用相对路径。
●代码的缩进用Tab，而不要用space。
●使用某个控件的值时，尽量命名局部变量。
publicstringGetTitle（）
{
stringStrTitle=lblTitle.Text;
StrTitle+=StrTitle;
returnStrTitle;
}
●一个方法只完成一个任务。
不要把多个任务组合到一个方法中。
●避免使用大文件。
如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
1.1.1.1.1.2控件命名规范
以下控件为常用的控件命名规范，按英文字母进行升序排列。
在此列表中未定义的控件，将后期补充完善。
控件类型命名前缀举例
3DPanelpnlpnlGroup
ADODataadoadoBiblio
AnimatedbuttonanianiMailBox
ButtonbtnbtnOK
CheckboxchkchkReadOnly
ComboboxcbocboEnglish
DropdownlistboxddlddlUser
CommandbuttoncmdcmdExit
CommondialogdlgdlgFileOpen
CommunicationscomcomFax
Control（usedwithinprocedureswhenthespecifictypeisunknown）
ctrctrCurrent
DatadatdatBiblio
Data-boundcomboboxdbcbodbcboLanguage
Data-boundgriddbgrddbgrdQueryResult
Data-boundlistboxdblstdblstJobType
DatacombodbcdbcAuthor
DatagriddgddgdTitles
DatalistdbldblPublisher
DatarepeaterdrpdrpLocation
DatepickerdtpdtpPublished
DirectorylistboxdirdirSource
DrivelistboxdrvdrvTarget
FilelistboxfilfilSource
FlatscrollbarfsbfsbMove
FormfrmfrmEntry
FramefrafraLanguage
GaugegaugauStatus
GraphgragraRevenue
GridgrdgrdPrices
HierarchicalflexgridflexflexOrders
HorizontalscrollbarhsbhsbVolume
ImageButtonibtnImageButton
ImageimgimgIcon
ImagecomboimgcboimgcboProduct
ImageListilsilsAllIcons
LabellbllblHelpMessage
LightweightcheckboxlwchklwchkArchive
LightweightcomboboxlwcbolwcboGerman
LightweightcommandbuttonlwcmdlwcmdRemove
LightweightframelwfralwfraSaveOptions
LightweighthorizontalscrollbarlwhsblwhsbVolume
LightweightlistboxlwlstlwlstCostCenters
LightweightoptionbuttonlwoptlwoptIncomeLevel
LightweighttextboxlwtxtlwoptStreet
LightweightverticalscrollbarlwvsblwvsbYear
LinelinlinVertical
ListboxlstlstPolicyCodes
ListViewlvwlvwHeadings
linkButtonlbtnlinkButton
MAPImessagempmmpmSentMessage
MAPIsessionmpsmpsSession
MCImcimciVideo
MenumnumnuFileOpen
MonthviewmvwmvwPeriod
MSChartchchSalesbyRegion
MSFlexgridmsgmsgClients
MSTabmstmstFirst
OLEcontaineroleoleWorksheet
OptionbuttonoptoptGender
PictureboxpicpicVGA
PictureclipclpclpToolbar
ProgressBarprgprgLoadFile
RemoteDatardrdTitles
RichTextBoxrtfrtfReport
RepeaterrptrptQueryResults
ShapeshpshpCircle
SlidersldsldScale
SpinspnspnPages
StatusBarstastaDateTime
SysInfosyssysMonitor
TabStriptabtabOptions
TextboxtxttxtLastName
TimertmrtmrAlarm
ToolbartlbtlbActions
TreeViewtretreOrganization
TabletbltblCountryCodes
UpDownupdupdDirection
VerticalscrollbarvsbvsbRate
1.1.1.1.1.3ADO.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
1.1.1.1.1.4自定义控件命名规范
自定义控件注册时，必须以“Custom“申明。
例如：
<%@RegisterTagPrefix="Custom"Namespace="CustomComponents"%>
使用时：
CreditCardFormrunat="server"ID="customCreditCard”/>
1.1.1.1.1.5类型声明
在定义变量时，以前缀开头，再加上变量声明符，为了不与系统控件命名起冲突，类型命名时，前缀第一个字母大写。
●整型
类型
前缀
示例
Sbyte
Sby
SbySex
Short
Shr
ShrAverage
Int
Int
IntRowCounter
Long
Lng
LngBillGatesIncome
Byte
Byt
BytPixelValue
Ushort
Ushr
UshrMoney
Uint
Uint
UintCount
Ulong
Ulng
UlngCount
●浮点型
类型
前缀
示例
Flost
Fot
FotMoney
Double
Dou
DouMoney
Decimal
Dec
DecMoney
●Bool类型
类型
前缀
示例
Bool
Boo
BooIsPostBack
●字符类型
类型
前缀
示例
Char
Chr
ChrSelectSex
●引用类型
类型
前缀
示例
Object
Obj
ObjReturnValue
String
Str
StrName
1.1.1.1.1.6常量
全部大写，单词之间以“_”分隔，例：
USER_PASSWORD。
1.1.1.1.1.7类的命名
类名必须以Cls前缀开头。
例如:
publicclassClsTextBox
{
publicvoidDataBind（）
{
}
}
1.1.1.1.1.8抽象类定义
抽象类必须以AbsCls前缀开头。
例如：
publicabstractclassAbsClsTextBox
{
}
1.1.1.1.1.9密封类定义
密封类必须以SeaCls前缀开头。
例如：
publicsealedclassSeaClsTextBox
{
}
1.1.1.1.1.10方法定义
大小写形式，一般将其命名为动宾短语.
如：
ShowDialog（）
CreateFile（）
1.1.1.1.1.11虚方法定义
在方法定义的基础上，加上Vir前缀来表示虚方法。
如：
publicvirtualstringVirShowDialog（）
{
}
publicvirtualstringVirCreateFile（）
{
}
1.1.1.1.1.12类的成员定义
参照类型声明；
1.1.1.1.1.13结构定义
结构名必须以Srt前缀开头。
如:
publicstructSrtDimensions
{
publicstringStrName;
publicstringStrPassword;
}
1.1.1.1.1.14结构成员定义
参照类型声明；
1.1.1.1.1.15接口定义
接口名称前加I前缀开头。
interfaceICompare
{
}
1.1.1.1.1.16接口的方法和成员定义
参照类的方法和成员的定义规则。
1.1.1.1.1.17自定义异常定义
自定义异常类型以Cls前缀开头，以Exception作为后缀命名。
例：
publicclassClsMyException:
Exception
{
}
1.1.1.1.1.18注释规范
1、注释必须使用中文及中文的标点符号。
2、每行注释的最大长度不能超过1024*800的宽度，且需要与代码对齐。
3、将注释与注释分隔符用一个空格分开。
4、编码的同时书写注释。
5、重要变量必须有注释。
6、变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个Tab键。
7、典型算法必须有注释。
8、在循环和逻辑分支的地方必须写上注释。
9、程序段或语句的注释在程序段或语句的上一行。
10、在代码交付之前，必须删掉临时的或无关的注释。
文件与函数的注释
1、文件和函数的头部都必须有概述注释信息。
2、文件和函数的概述注释应缩进1个空格。
3、文件概述注释信息必须包括以下内容：
a）文件名
b）属性
c）创建人
d）创建日期
4、函数概述注释信息必须包括以下内容：
a）功能
b）输入参数，标明意义和类型
c）返回值，标明意义和类型
d）作者
e）日期
1.1.1.1.2XHTML的编码规范
Ø所有的标记都必须要有一个相应的结束标记
Ø所有标签的元素和属性的名字都必须使用小写
Ø所有的XML标记都必须合理嵌套
Ø所有的属性必须用引号""括起来
Ø把所有<和&特殊符号用编码表示
Ø给所有属性赋一个值
Ø不要在注释内容中使“--”
Ø属性最小化
1.1.1.1.3CSS编码规范
1.1.1.1.3.1基本书写规范
1、所有的CSS尽量采用外部调用
书写时重定义的最先，伪类其次，自定义最后（其中a:
linka:
visiteda:
hovera:
actived要按照顺序写）便于自己和他人阅读。
2、CSS推荐模板:
—
body{font-size:
9pt;font-family:
Arial,Helvetica,sans-serif;color:
#333333;text-align:
center;margin:
0px;}
ul{margin:
auto;}
img{border:
0px;}
a{font-size:
9pt;text-decoration:
none;color:
#FFFFFF;}
a:
hover{font-size:
9pt;text-decoration:
underline;color:
#990000;}
a.1{font-size:
9pt;color:
#3366cc;text-decoration:
none}
a.1:
hover{font-size:
9pt;color:
#FF9900;text-decoration:
none}
.colorblue,colorblue:
hover{color:
#003366;}
.blue{font-family:
"宋体";font-size:
9pt;line-height:
20px;color:
#0099FF;letter-spacing:
5em}
.colorRed,a.colorRed:
hover{color:
#FF0000;}
.colorLime,a.colorLime:
hover{color:
#00FF00;}
.colorGreen,a.colorGreen:
hover{color:
#008000;}
.colorBlue,a.colorBlue:
hover{color:
#0000FF;}
.colorOrange,a.colorOrange:
hover{color:
#FFA500;}
-->
为了保证浏览器的兼容性，必须设置页面背景
3、注意其中注释写法，例：
/*headerbegin!
*/
1.1.1.1.3.2CSS命名参考
1、常用的CSS命名：
头：
header
内容：
content/container
尾：
footer
导航：
nav
侧栏：
sidebar
栏目：
column
2、直观命名
使用可以描述元素所在页面位置的词汇来对其命名。
这种方法使得类以及id的名称如下面所示：
自上而下小组：
top-panel
横向：
horizontal-nav
左面：
left-side
中心-栏目：
center-column
右面：
right-col
3、结构化命名
可以按照如下所示的结构化方式来对类以及id名称命名：
顶部抢眼部分：
branding
导航部分：
main-nav
主要内容部分：
main-content
1.1.1.1.3.3CSS样式书写顺序
1、显示属性
*display*list-style*position*float*clear
2、自身属性
*width*height*margin*padding*border*background
3、文本属性
*color*font*text-decoration*text-align
*vertical-align*white-space*othertext*content
升级会员 