代码编写规范范本
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
///修改描述: <对此修改的描述>
///作者:修改者中文名
///修改日期: <模块修改日期,格式:YYYY-MM-DD>
///
2. 类属性注释规范
III
III属性说明
III
3. 方法(函数)注释规范
III
III说明: <对该方法的说明>
III
III vparam name="<参数名称 >"><参数说明 >
III
III<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
III
4. 代码间注释规范单行注释:
II<单行注释>
多行注释:
I*多行注释1
多行注释2
多行注释3*I
代码中遇到语句块时必须添加注释(if,for,foreach, •)…,添加的注释必须能
够说明此语句块的作用和实现手段(所用算法等等)。
2 •控件命名规范。控件命名规则一般为前缀+字段名。
示例:字段Title,在界面中的控件为textbox 命名为txtTitle 下列为各种控件所统一的前缀
标准控件
1 btn Button
2 chk CheckBox
3 ckl CheckedListBox
4 cmb ComboBox
5 dtp DateTimePicker
6 lbl Label
7 llb Lin kLabel
8 lst ListBox
9 lvw ListView
10 mtx MaskedTextBox
11 cdr Mo nthCale ndar
12 icn NotifyIco n
13 nud NumeircUpDow n
14 pic PictureBox
15 prg ProgressBar
16 rdo RadioButt on
17 rtx RichTextBox
18 txt TextBox
19 tip ToolTip
20 tvw TreeView
21 wbs WebBrowser
数据
1 dts DataSet
2 dgv DataGridView
3 bds Bindin gSource
4 bdn
Bin di ngNavigator
5 rpv Reportviewer
}
catch(Excepti on ee) {
//your code
}
}
catch(Excepti on e) {
//your code }