超级链接引用无效。
'path='错误!
超级链接引用无效。
[@错误!
超级链接引用无效。
="错误!
超级链接引用无效。
"]'/>
filename包含文档的文件名。
该文件名可用路径加以限定。
将filename括在单引号中('')。
Tagpath:
filename中指向标记名的标记路径。
将此路径括在单引号中('')。
name注释前边的标记中的名称说明符;名称具有一个id。
id
位于注释之前的标记的id。
将此id括在双引号中("")。
标记使您得以引用描述源代码中类型和成员的另一文件中的注释。
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
标记使用XMLXPath语法。
有关自定义使用的方法,请参阅XPath文档。
错误!
超级链接引用无效。
错误!
超级链接引用无效。
错误!
超级链接引用无效。
错误!
超级链接引用无效。
term定义的项,该项将在text中定义。
description目符号列表或编号列表中的项或者term的定义。
块用于定义表或定义列表中的标题行。
定义表时,只需为标题中的项提供一个项。
列表中的每一项用- 块指定。
创建定义列表时,既需要指定term也需要指定text。
但是,对于表、项目符号列表或编号列表,只需为text提供一个项。
列表或表所拥有的- 块数可以根据需要而定。
超级链接引用无效。
错误!
超级链接引用无效。
"member">错误!
超级链接引用无效。
cref="member"对可以通过当前编译环境进行调用的成员或字段的引用。
编译器检查到给定代码元素存在后,将member转换为输出XML中的规范化元素名。
必须将member括在双引号("")中。
description成员的访问的说明。
标记使您得以将成员的访问记入文档。
System.Security.PermissionSet使您得以指定对成员的访问。
错误!
超级链接引用无效。
description成员的说明。
标记是可以指定有关类或其他类型的概述信息的位置。
是可以描述该类型的成员的位置。
错误!
超级链接引用无效。
description返回值的说明。
标记应当用于方法声明的注释,以描述返回值。
错误!
超级链接引用无效。
property-description属性的说明。
标记使您得以描述属性。
请注意,当在VisualStudio.NET开发环境中通过代码向导添加属性时,它将会为新属性添加标记。
然后,应该手动添加标记以描述该属性所表示的值。
3代码注释
3.1文件注释
1在每个文件头必须包含以下注释说明
//----------------------------------------------------------------
//Copyright(C)2004长沙齐跃科技有限公司
//版权所有。
//
//文件名
//
//文件功能描述
//
//
//创建标识:
//
//修改标识:
//修改描述:
//----------------------------------------------------------------
文件功能描述只需简述,具体详情在类的注释中描述。
3.2代码修改注释
修改标识由修改人员的姓名加日期组成。
如
//beginmodifyby张辉20040708原因+其他
……
//endmodifyby张辉20040708
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
3.3函数、事件注释
分功能注释块、参数注释块、举例说明注释块、返回值注释块。
如:
/*功能注释
*/
/*参数注释
*/
/*举例说明注释
*/
/*返回值注释
*/
4命名规范
4.1命名概述
名称应该说明“什么”而不是“如何”。
通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。
例如,可以使用GetNextStudent(),而不是GetNextArrayElement()。
命名原则是:
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。
使名称足够长以便有一定的意义,并且足够短以避免冗长。
唯一名称在编程上仅用于将各项区分开。
表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。
不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1避免容易被主观解释的难懂的名称,如方面名AnalyzeThis(),或者属性名xxK8。
这样的名称会导致多义性。
2在类属性的名称中包含类名是多余的,如Book.BookTitle。
而是应该使用Book.Title。
3只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4在变量名中使用互补对,如min/max、begin/end和open/close。
5布尔变量名应该包含Is,这意味着Yes/No或True/False值,如fileIsFound。
6即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名,如i或j。
可能的情况下,尽量不要使用原义数字或原义字符串,如Fori=1To7。
而是使用命名常数,如Fori=1ToNUM_DAYS_IN_WEEK以便于维护和理解。
4.2大小写规则
大写标识符中的所有字母都大写。
仅对于由两个或者更少字母组成的标识符使用该约定。
例如:
System.IO
System.Web.UI
下表汇总了大写规则,并提供了不同类型的标识符的示例。
标识符
大小写
示例
类
Pascal
AppDomain
枚举类型
Pascal
ErrorLevel
枚举值
Pascal
FatalError
事件
Pascal
ValueChange
异常类
Pascal
WebException
注意总是以Exception后缀结尾。
只读的静态字段
Pascal
RedValue
接口
Pascal
IDisposable
注意总是以I前缀开始。
方法
Pascal
ToString
命名空间
Pascal
System.Drawing
属性
Pascal
BackColor
公共实例字段
Pascal
RedValue
注意很少使用。
属性优于使用公共实例字段。
受保护的实例字段
Camel
redValue
注意很少使用。
属性优于使用受保护的实例字段。
私有的实例字段
Camel
redValue
参数
Camel
typeName
方法内的变量
Camel
backColor
4.3缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
1不要将缩写或缩略形式用作标识符名称的组成部分。
例如,使用GetWindow,而不要使用GetWin。
2不要使用计算机领域中未被普遍接受的缩写。
3在适当的时候,使用众所周知的缩写替换冗长的词组名称。
例如,用UI作为UserInterface的缩写,用OLAP作为On-lineAnalyticalProcessing的缩写。
4在使用缩写时,对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。
例如,使用HtmlButton或HTMLButton。
但是,应当大写仅有两个字符的缩写,如,System.IO,而不是System.Io。
5不要在标识符或参数名称中使用缩写。
如果必须使用缩写,对于由多于两个字符所组成的缩写请使用Camel大小写,虽然这和单词的标准缩写相冲突。
4.4控件命名
C#控件的前缀名表
控件
前缀名
示例
Label
lbl
lblNextName
linkLabel
lnklbl
lnklblPhone
Button
btn
btnAdd
TextBox
txt
txtDell
MainMenu
mmnu
mmnuSystem
CheckBox
chk
chkPerson
RadioButton
rbtn
rbtnSettings
GroupBox
gbox
gboxQueryCondition
PictureBox
pbox
pboxToolBar
Panel
pan
panQuery
DataGrid
dgrd
dgrdShowData
ListBox
lst
lstDepotCode
CheckedListBox
chkl
ChklReadOnly
ComboBox
cbo
cboPersonCode
ListView
lvw
LvwSchool
TreeView
tre
TreCityName
TabControl
tab
tabSettings
DateTimePicker
dtp
dtpDate
MonthCalendar
mthc
mthcDown
HScrollBar
hsb
hsbMouseSensitiviy
VScrollBar
vsb
vsbPageUp
Timer
tmr
tmrTrigger
Splitter
spl
splCut
DomainUpDown
dupd
dupdControl
NumericUpDown
nupd
nupdControl
TrackBar
tbar
tbarFileSend
ProgressBar
prg
prgStates
RichTextBox
rtf
rtfNotes
ImageList
ils
ilsToolBarImages
HelpProvider
hlp
HlpCommandF1
ToolTip
tlt
tltShowText
ContextMenu
cmnu
cmnuBrowse
ToolBar
tlb
tlb
StatusBar
sta
staMessage
NotifyIcon
nico
nicoChangeIco
OpenFileDialog
ofdlg
ofdlgOpenFile
SaveFileDialog
sfdlg
sfdlgSaveFile
FolderBrowserDialog
fbdlg
fbdlgBrowserFile
ColorDialog
cdlg
cdlgChangeColor
PrintDialog
pdlg
pdlgChangePrint
PrintPreviewDialog
ppdlg
ppdlgShow
PrintPreviewControl
ppctr
ppctrUserLevel
ErrorProvider
errp
errpShowMessage
PrintDocument
pdoc
pdocPrintFile
PageSetupDialog
psdlg
psdlgChangePage
CrystalReportViewer
crpt
crptPrintReport
4.5变量
所有变量的变量名,名字前均包含由两个小写字母组成的前缀。
前缀的第一个字母表明变量的范围,第二个字母表明变量数据类型。
本地变量不用范围指示,类属性和方法过程的参数不使用范围和数据类型前缀。
第一个字母(范围)
Public
g
Private(protected)
p
Form
f
Class
c
Local
l
Internal
i
第二、三个字母(数据类型)
Boolean
bo
Byte
by
sByte
sb
string
st
short
sh
ushort
us
int
in
uint
ui
long
lo
ulong
ul
decimal
de
char
ch
float
fl
double
do
4.6命名空间
1命名命名空间时的一般性规则是使用公司名称,后跟技术名称和可选的功能与设计,如下所示。
CompanyName.TechnologyName[.Feature][.Design]
例如:
namespacecsit.mes//艾特公司的MES系统
namespacecsit.mes.DataRules//艾特公司的MES系统的业务规则模块
2命名空间使用Pascal大小写,用逗号分隔开。
3TechnologyName指的是该项目的英文缩写,或软件名。
4该用复数的时候要使用复数的名称空间名。
例如,使用System.Collections而不是System.Collection。