闲谈高效率编程（一）——代码重构

之前在一个博客里看到高手与菜鸟的区别无非有三点：1、清晰规范的文档及注释　2、更少的代码　3、模块内高内聚，模块间低耦合；当然从实际项目编码方面讲这三点基本概括了代码质量的含义，软件=程序+文档，谁也无法否认。

读过冗长缺乏注释的代码吧？那你肯定体会到文档及注释的重要性了，我们团队里一个成员习惯代码从不注释，我讲到代码规范时他总是说自己的代码自己记得，后来他离职了，留下的代码被团队称为“天书”，——混乱的变量命名、团队成员戏言“花一个月读懂代码，花两个月修改代码”，而实际上整个项目的周期不过几个月，接手该人的代码的那位于是出现想删不舍不得删（毕竟上万行！），想改又改不了的窘境。

程序员要劳记三种变量命名方式：Camel命名、Pasaca命名和匈牙利命名，javascript方法普遍采用Camel命名，而C#中普遍采用Camel（普通变量）加Pasaca（方法）命名。当然我本人还有一份命名方法（应该不是原创），就是对文件及QueryString字符串使用小写英语单词缩写及加下划线，如manage_news_list.aspx?news_class_id=1。

个人认为菜鸟容易出现的变量名就是”懒惰“的变量名，比如GridView1、Form1、LinkButton1……，想象一下一个页面有上百个 TextBox，到最后TextBox100的时候你应该不会很好过吧。类似的有文件名Default1.aspx,..Default6.aspx，控件名、方法名、变量名，最bt的是有些人发过来代码让我改，解压出来是这个样子

哪让程序都是外国人开发的呢？：（
同样的功能，高手的代码往往短小精悍，令人击节叹赏。

差的程序往往“千姿百态”

过多循环嵌套

无注释（上百个字段哦）

还有就是“代码行数”的问题，以下代码

int count = 0;
2

if (ViewState["reply"] != null)
3

{
4

string name = txtKey.Text.Trim().ToString();
5

GridDocReply.DataSource = bllDocReply.GetModelList("Reply_Title like ‘%" + name + "%’" + "or Reply_PostAuthor like ‘%" + name + "%’");
6

GridDocReply.DataBind();
7

count = bllDocReply.GetModelList("Reply_Title like ‘%" + name + "%’" + "or Reply_PostAuthor like ‘%" + name + "%’").Count;
8

}
9

else
10

{
11

GridDocReply.DataSource = bllDocReply.GetAllList();
12

GridDocReply.DataBind();
13

count = bllDocReply.GetAllList().Tables[0].Rows.Count;
14

}

改进后

int count = 0;//记录条数
2

string strWhere = "1=1";
3

if (ViewState["reply"] != null)
4

{
5

string keyWords = txtKey.Text.Trim().ToString();//查询关键字
6

strWhere += "Reply_Title LIKE ‘%" + keyWords + "%’" + "OR Reply_PostAuthor LIKE ‘%" + keyWords + "%’";
7

}//查询
8

GridDocReply.DataSource = bllDocReply.GetModelList();
10

GridDocReply.DataBind();
11

count = bllDocReply.GetModelList(strWhere);

近两年Web开发界盛行页面重构，是时候了，代码也要重构。

模块内代码简写及规范原则有以下几点：
1、使用三元运算符代替简单的if{…}else{…}（据说三元运算符效率稍低下，但在软件工程中讲代价值得的）；

2、冗长的else可考虑使用switch(){case:…}代替，增强可读性；

3、静态数字常量最好开始以变量形式定义并做好注释；

4、频繁使用的变量可考虑将其归为属性成员

模块间代码优化是我一直在探索的，软件开发“高内聚低耦合”的原则并不是严格非要规定如何定义模块间的关系，耦合性由代码编写人员根据自身经验决定，提高这方面技能需要在长期经验下熟悉设计模式、系统架构的基础上得到。我的经验是同一项目中某些不涉及实际功能操作的全局方法可将其归为公用类中，同一文件内两次以上使用的方法依据工厂模式思想将其提取为公用方法。

另一方面就是代码格式的规范

遵循原则：

1、文件头标注开发者、功能、开发时间、最后修改时间、修改详情；

2、方法头标注功能、输出参数、输入参数；

3、方法体内重要代码及疑难代码行内注释；

4、if else类代码优先考虑标注，标注在右大括号之后；

5、数据成员、数据操作分组，两者之间空一行区分；

6、方法之间空一行；

7、适当使用#region块注释，以便长（属性）方法折叠；

8、采用垂直对齐，tab缩进，以保证代码上下整齐；

9、嵌套类（如if else及for）一般不要超过三层；

10、正式发布时删除注释屏蔽类代码（如/*…….*/）

Web开发中还要考虑html的格式，普遍采用xhtml格式规范，并额外附加

1、除</head>与<body>之间空一行外其余无空行；

2、标记垂直对齐加tab缩进，同一行字符过多情况下可将同一级标签换行；

3、数据显示使用table，布局使用div，写好全局css样式引用，避免行内书写css，达到结构与样式分离；

4、公用js操作归为全局外部js引用，文件内尽量使用匿名方法，达到结构与行为分离；

以上规范不一而足，以下是我们日常总结的一个编码规范，针对c#编程人员，网上流传着一份东软的编码规范，可以下载看看。

变量命名及编码规范.rar

以上仅是个人观点，希望抛砖引玉。（查看原文）

posted @ 2009-10-14 13:31 walkingp 阅读(3300) 评论(31) 编辑收藏举报

walkingp

扬长方能避短

闲谈高效率编程（一）——代码重构