开发代码规范(补充)

1、IFS 后台代码规范：
IFS 后台代码遵守《软件开发规范(PLSQL).doc》文档规范。

其中现将相关补充如下：
1.1命名基本规则：所有IFS 后台代码（数据库）使用英文单词或英文简写，各英文连接使用下划线”_”连接符。

如果是我司客户化的Oracle对象(表、视图、包等)必须使用DJ开始。

例：建立车间加工零件表、视图、包命名为：
DJ_SHOP_MAKE_PART_TAB（普通视图）
DJ_SHOP_MAKE_PART_REP（RDF文档视图）
DJ_SHOP_MAKE_PART（普通视图）
DJ_SHOP_MAKE_PART_API
1.2 IFS 表或视图增加字段：在IFS表或视图增加字段必须以DJ开始，以便区别该字段为我司自行增加的字段；
1.3 IFS包增加函数或过程：在IFS包增加函数或过程必须以DJ开始，以便区别该函数或过程为我司自行增加的函数或过程，同时增加“modify by 姓名日期/end by姓名日期”的注释原因；
1.4视图规则：所有IFS建立视图各列必须增加别名，包括我司客户化视图，以便和IFS风格统一，如：
即co.order_no 使用order_no别名，而customer_info_public视图使用ci或cip（各单词首个字母）。

1.5程序风格：所有程序风格请遵守《软件开发规范(PLSQL).doc》文档规范程序风格，注重代码工整以及相关行缩进。

2、SQL SERVER数据库：
2.1基本命名：命名过程中如有现存的缩写，则使用该缩写，如无，一律不得缩写，
例：ISBN
数据库：用一个或三个以下英文单词组成，单词首字母大写，如：DepartmentManage；表名：使用大写名词性质的单词或编写表示，各单词首字母大写，如果只有一个单词，统一采用单数形式，即为Order而不是Orders；多字母如：BookAuthor。

视图：使用vw_+名词性质的单词或编写表示，各单词首字母大写如：vw_BookAuthor
过程：使用pt +名词性质+操作类型的单词编写来表示，各单词首字母大写如：pt_BookAuthorNew，表示过程为新增的，即pt_+名词性质+New表示新增功能，pt_+名词性质+Modify表示修改，pt_+名称性质+Remove表示删除，pt_+名称性质表示查询。

Function ：使用fn+名词性质的单词或编写表示，各单词首字母大写如：fn_BookAuthor 表、存储过程、视图等对象的所有都为dbo，不要使用数据库用户名，这样会影响数据库用户的更改。

2.2其它对象
1.触发器以TR_为前缀
2.主键以PK_为前缀
3.索引以IX_为前缀
4．如果对象对立在其它系统之上务必首两位字母加上Dj，以表示东箭客户化所用。

2.3表字段
1. 表字段：表中的字段一般使用名词性质的单词全拼表示，采用一个或三个以下英文单词组成，单词首字母大写，如：UserName;
2. 主键：表主键名称为表名+ID（或表编写+ID），如Document表的主键名为：DocumentID 或DMID(DepartmentManage)
3. 自动增长：表中自动增长的列一律命名为：Id，同样可以作为主键。

4. bool型：如果字段为bool型，则使用"IsShow","IsValid"这种形式表示
2.4程序风格：
注意代码工整以及相关行缩进，提高程序的可读性。

3、C#语言
命名要使用具有实际意义的英文单词。

3.1控件基本命名
Lable：以lbl开始+意义名称不能使用Lable1和lable2等无意名称，应使用lblUser类似名称
TextBox：以txt开始+意义名称，不能使用TextBox1和TextBox2等无意名称，应使用txtUser 类似名称
Button和LinkButton、ImageButton：以btn开始+意义名称,不能使用Button1和Button2等无意名称,应使用btnSubmit类似名称
DropDownList:以ddl开始+意义名称，ddlDept
ListBox：以lst开始+意义名称,lstUser
CheckBox：以chk开始+意义名称
Panel：以pn开始+意义名称
HiddenField：以hf开始+意义名称
GridView：以gv开始+意义名称
….控件或NET对象主要以各英文首字母开始。

3.2程序规则
1、命名局部变量和方法的参数.
如果变量或方法参数由多个单词组成，第一个单词全部小写，第二个单词首字母大写而其它小写。

如：
string userName;
public User New(string userId, byte[] password);
2、方法命名：
如果名如果由多个单词组成，各单词首字母大写，其它小写。

如： public User N ew(string userId, byte[] password);
3、成员变量命名：成员变量加前缀_，其它规则遵守局部变量命名。

public class Database
{
public string _connectionString;
public string _userName;
}
4、常量(Const)
用大写或者大写后加“_”。

const int UPPERCASE = 0;
const int UPPERCASE_WITH_UNDERSCORES = 0;
5、Bool变量
is+形容词、can+动词、has+过去分词、三单元动词、三单元动词＋名词。

bool isEmpty;
6、循环计数器
对于应用的局部循环计数器，以ｉ,ｊ,ｋ为顺序依次命名。

7、接口名
与类名相同。

此外，最前面添加I。

interface IClassName
此外,在使用添加了某项功能的情况下,我们要加上可以表示这种功能的形容词,以-able结尾。

例: IEnumerable, ICloneable, IXmlSerializable
8、文件名Public类的命名一定要与文件名同名(包括大,小写的区别)。

9、异常类名最后以Exception结尾。

10、NameSpace结构规范NameSpace分类和命名原则先根据业务系统（Application）、子系统（Sub）、模块(Module) 划分目录，然后在模块内部按照Web、Biz、integration层对NameSpace 结构进行命名。

Web层NameSpace命名规范Application.Sub.Module.Web
业务层NameSpace命名规范
数据访问层NameSpace命名规范Solution.Application.Sub.Data
集成层NameSpace命名规范 Common
11、避免将多个类放在一个文件里面。

12、一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。

13、一个文件最好不要超过500行的代码（不包括机器产生的代码）。

14、一个方法的代码长度最好不要超过25行。

15、避免方法中有超过5个参数的情况。

使用结构来传递多个参数。

16、每行代码不要超过80个字符。

17、避免在只读的变量上使用const。

如果想实现只读，可以直接使用readonly。

public class MyClass
{
public readonly int Number;
public MyClass(int someValue)
{
Number = someValue;
}
public const int DaysInWeek = 7;
}
18、在捕获(catch)语句的抛出异常子句中(throw)，总是抛出原始异常维护原始错误的堆栈分配。

catch(Exception exception)
{
MessageBox.Show(exception.Message);
throw ; //和throw exception一样。

}
3.3注释
修改别人代码时需要加入moidy by xxx 日期，再加上注释原因，例如：。