记录本人在项目中所使用的规范,各种规范应该在项目启动前就已经确立,如果后面修改起来那真他妈的烦啊,现在我在的项目就是这种情况,所以总结一下,留待后用,也和大家一起讨论或分享,不一定适合所有人,不足之处请拍砖,如果您在项目中用到的规范不妨也贴出来,让大家学习一下,谢谢!
想到哪写到哪,可能写得有点乱,先写出来以后再整理吧!也等待大拿们的规范,一起整理出一套规范文档.
1、使用空格,不用tab
编写代码时,为了易读和美观,尽量使用空格,不用tab,也可以把tab设置成几个空格。因为在移动代码保持内容格式不会发生变化
2、get访问器放在set访问器 之前
通常写法应该是Get{} Set{},在修改项目代码时发现以前代码的写法 是set{} get{},很纳闷,改起来也很无语。
3、类,方法,成员要添加注释,以及参数说明
在写代码时添加注释很简单输入///即可自动生成,但生成之后也要把描述信息和参数说明也写上,不要让后人擦屁股
4、Using 声明 和namespace之间 隔一行
即美观更易读。
5、类文件顶部添加说明
内容一般包括:
View Code
1 /* **************************************************************
2 * Copyright(c) 2005 SYSTEMS Corporation, All Rights Reserved.
3 * File : .cs
4 * Description :
5 * Author :
6 * Created :
7 * Traceability :
8 * Revision History :
******************************************************************/
6、代码分块处理
代码行数比较多时,分块比较容易组织,也易读,更美观 ,个人把他分为:
View Code
1 #region variables
2 #endregion
3
4 #region constructors
5 #endregion
6
7 #region Properties
8 #endregion
9
10 #region internal methods
11 #endregion
12
13 #region Public methods
14 #endregion
15
16 #region Private methods
17 #endregion
7、声明变量时尽量不要用大写的类型来声明
View Code
1 string knjId = string.Empty;
2
3 String knjId = string.Empty;
8、每行代码的长度
每行代码过长不易读,眼瞅起来也非常累,所以尽量保持代码不要过长,我们项目规定是 110
9、等号左右有空格
好的写法
private string knjId = string.Empty;
不好的写法
private string knjId=string.Empty;
10、不要吝啬{}
我们写if 或 for 语句时 喜欢不用{},代码是少两行,但不易读,容易让人误解
View Code
1 if (nHandler == null)
2 {
3 return this.Create(searchCriteria);
4 }
5 return null;
6 Or
7 if (nHandler == null)
8 {
9 return this.Create(searchCriteria);
10 }
11 else
12 {
13 return null;
14 }
if (nHandler == null)
return this.Create(searchCriteria);
return null;
11、三元运算符合理运用,不要太吝啬行数
12、。。。。等待兄弟们来贴