【浙大网新图灵通讯】无废话简单高效C#编码规范20100612
2010-06-12 12:22 通用C#系统架构 阅读(1016) 评论(2) 编辑 收藏 举报
无废话简单高效C#编码规范20100612
自己看自己的代码啥问题也没有,但是一个团队、N多个人、N多年的代码,就比较难维护、难阅读了,什么样的不好的习惯、错误漏洞能出来的就全出来了。
第1章 程序细节参考
※ 错误参考
messageReceiver.IsShow = Convert.ToInt32(dataRow["Is_Show"]) == 1 ? true : false;
1.1 规范定义
建议不要写多余的没多大必要的 true : false。
正确代码参考
messageReceiver.IsShow = Convert.ToInt32(dataRow["Is_Show"]) == 1;
※ 错误参考
MessageAttachment result = null;
result = PackAttachment(table.Rows[0]);
return result;
1.2规范定义
没必要的中间过度变量建议尽量就避免了。
正确代码参考
return PackAttachment(table.Rows[0]);
※ 错误参考
DataSet GetApothecaryUnOnDateList( string code,string begin,string end);
1.3规范定义
变量与变量之间要有空格隔开,该有空格时有空格,不该有的空格删除掉,不要紧紧挨在一起。
1.4规范定义
尽量从变量的名字、变量的类型中可以知道变量的详细限制,例如 begin 写为 beginDate。
正确代码参考
DataSet GetApothecaryUnOnDateList(string code, string beginDate, string endDate);
※ 错误参考
/// <summary>
/// packE
/// </summary>
public string packE
{
get { return _packE; }
set { _packE = value; }
}
1.5规范定义
属性要写注释,否则谁知道这个是什么呀?。
1.6规范定义
属性要大写字母开头,很少见微软的程序,属性小写开头,该大写的不大写,改小写的不小写。
1.7规范定义
若没必要,尽量不要用_。
正确代码参考
/// <summary>
/// 包装名(英文名)
/// </summary>
public string PackE
{
get { return packE; }
set { packE = value; }
}
※ 错误参考
/// <summary>
/// 国家库进口药品信息实体
/// </summary>
[Serializable]
public class MediImportInfo
1.8规范定义
实体类,尽量用*Entity 这个类名,这样大家很容易知道,这个是实体类?控制类?。
正确代码参考
/// <summary>
/// 国家库进口药品信息实体
/// </summary>
[Serializable]
public class MediImportInfoEntity