代码编写要求规范说明书.doc

word
word
1 / 13
word
代码编写规X说明书〔c#.〕
目 录
1 目的
2 X围
3 注释规X
概述
自建代码文件注释
模块〔类〕注释
类属码使用以下注释：
///Added by Add date：<添加日期，格式：YYYY-MM-DD> Start2：
///End2：
如果模块输入输出参数或功能结构有较大修改，如此每次修改必须添加以下注释：
///<summary>
///Log ID：<Log编号,从1开始一次增加>
///depiction：<对此修改的描述>
///Writer：修改者中文名
///Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>
///</summary>
类属性注释
在类的属性必须以以下格式编写属性注释：
/// <summary>
/// <Properties depiction>
/// </summary>
方法注释
在类的方法声明前必须以以下格式编写注释
/// <summary>
/// depiction：<对该方法的说明>
/// </summary>
/// <param name="<参数名称>"><参数说明></param>
/// <returns>
///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>
/// </returns>
///Writer：作者中文名
///Create Date：<方法创建日期，格式：YYYY-MM-DD>
代码间注释
代码间注释分为单行注释和多行注释：
//<单行注释>
/*多行注释1
多行注释2
word
word
4 / 13
word
多行注释3*/
代码中遇到语句块时必须添加注释〔if,for,foreach,……〕,添加的注释必须能够说明此语句块的作用和实现手段〔所用算法等等〕。
4 命名总体规如此
Ø名字应该能够标识事物的特性。
Ø名字一律使用英文单词，而不能为拼音。
Ø名字尽量不使用缩写，除非它是众所周知的。
Ø名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。
Ø在名字中，多个单词用大写第一个字母〔其它字母小写〕来分隔。例如：IsSuperUser。
Ø名字尽量使用前缀而不是后缀。
Ø名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete〔而不是FunctionDeleteUser〕。
5 命名规X
变量〔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
{
word
word
6 / 13
word
void say(string p_strSayWord)
{
}
}
补充说明：
针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为exp；
如果有冲突的情况下，可以用“exp〞+ 标志名称，如：expSql。
Try
{
//your code
try
{
//code
}
catch(Exception exp)
{
//your code
}
}
catch(Exception expSql)
{
//your code
}
补充：如果捕获异常不需要作任何处理，如此不需要定义Exception实例。
例：
try
{
//your code
}
c