从我工作到现在,我也参加了很多项目的代码设计和编写工作,也带过了不少的人员进行代码的设计和编写工作。总体上讲,一般刚刚在我带领的团队工作的人都会经历一段相当的痛苦的时期,那段时期他将会被我严重的教育“为了完成代码而写代码”的毛病。
其实这些毛病谁都发生。下面我就讲讲这么多年来,我见过的一些代码编写人员常犯的错误。
(本文的代码都是伪代码)
1.不遵循“先出域”原则
原代码
public void Save(string id)
{
if(string.IsNullOrEmpty(id))
{
//复杂的业务代码
}
else
{
return;
}
}改进后的代码
public void Save(string id)
{
if(!string.IsNullOrEmpty(id)) return;
//复杂的业务代码
}大家看明白了吗?改成下面一种以后是不是可读性加强了很多?!不管是在方法体,还是流程语句中,都要尽量把return语句往前靠,这样会增加可读性;
2.方法体过长,复杂度太高
原代码:
public void Save(string id)
{
for()
{
if()
{
}
else
{
}
for()
{
}
}
switch()
{
case:
{
}
case :
{
}
default:
{
}
}
}改进后的代码:
类似这种的方法只能进行拆分,同志们,这种拆分应该遵循一个原则:一个方法中的业务代码长度尽量不要超过5行(赋值语句除外)。这点虽然比较难,但是努力一下还是可以做到的。
3.将用户控件Id写死
原代码:
<script language="javascript" type="javascript/text">
function Test(string txtId)
{
document.getElementById("UserControls1_"+txtId)
}
</script>改进代码:
<script language="javascript" type="javascript/text">
function Test(string txtClientID)
{
document.getElementById(txtClientID)
}
</script>看明白了吗?在javascript的代码中,传递一个客户端Id,而不是服务器端ID就可以了,虽然这样的改动是很小的,但是绝对的让你后患无穷,各位想想看,如果你这段代码正好写在用户控件上,而这个用户控件在一个页面被使用了两次,那么你第一种写法能完成第二个用户控件中的功能吗?
![](https://img2024.cnblogs.com/blog/35695/202408/35695-20240826070647288-243310440.jpg)