bsp;
3.6 代码间注释
代码间注释分为单行注释和多行注释:
单行注释:
//<单行注释>
多行注释:
/*多行注释1
多行注释2
多行注释3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。
4 命名总体规则
Ø 名字应该能够标识事物的特性。
Ø 名字一律使用英文单词,而不能为拼音。
Ø 名字尽量不使用缩写,除非它是众所周知的。
Ø 名字可以有两个或三个单词组成,但不应多于三个,控制在3至30个字母以内。
Ø 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
Ø 名字尽量使用前缀而不是后缀。
Ø 名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如:FunctionUserDelete(而不是FunctionDeleteUser)。
在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义及上报质量管理部审计组。
5 命名规范
5.1 变量(Variable)命名
a) 程序文件(*.cs)中的变量命名
程序中变量名称 = 变量的前缀 +代表变量含意的英文单词或单词缩写。
Ø 类模块级的变量请用“m_” +数据类型缩写作为前缀(其中,m 为“memory”缩写,数据类型缩写见附件中的《数据类型缩写表》)。
public class hello
{
private string m_strName;
private DateTime m_dtDate;
}
Ø 类的属性所对应的变量,采用属性名前加“m_”+ 类型缩写 前缀的形式
public class hello
{
private string m_strName;
public string Name
{
get
{
return m_strName;
}
}
}
Ø 过程级的变量使用类型缩写前缀
public class hello
{
void say()
{
string strSayWord;
}
}
Ø 过程的参数使用“p_”+ 类型缩写作为前缀(其中,p 为“parameter”缩写)
public class hello
{
void say(string p_strSayWord)
{
}
}
补充说明:
针对异常捕获过程中的Exception变量命名,在没有冲突的情况下,统一命名为exp;
如果有冲突的情况下,可以用“exp”+ 标志名称,如:expSql。
Try
{
//your code
try
{
上一页 [1] [2] [3] [4] [5] [6] [7] [8] [9] 下一页 [C语言系列]NET 中C#的switch语句的语法 [系统软件]托拽Explore中的文件到VB.net的窗口 [系统软件]Boost库在XP+Visual C++.net中的安装 [常用软件]新配色面板:Paint.Net3.0RC1官方下载 [常用软件]用内建的“Net Meeting”聊天 [VB.NET程序]Henry的VB.NET之旅(三)—共享成员 [VB.NET程序]Henry的VB.NET之旅(二)—构造与析构 [VB.NET程序]Henry的VB.NET之旅(一)—失踪的窗体 [VB.NET程序]在托盘上显示Balloon Tooltip(VB.NET) [VB.NET程序]Henry手记-VB.NET中动态加载Treeview节点(二)
|