代码整洁之道(二)

3、函数

  程序员在打代码的过程中有大部分的时间都是在编写函数,那怎么写出一个整洁的函数呢?

①、短小原则。函数的规模尽量限制在200行以内。太多行会导致不容易阅读,而且现在电脑屏幕虽然变大了不少,每一行的字符也不应该太多,拉动横轴的滚动条会影响编码的效率,建议每行代码不超过80字符,专业阅读起来也较为舒服。

②、单一职能原则。每个函数应该要控制到只做一件事,如何判断函数是否只做了一件事情:看该函数是否能再拆出一个函数,该函数不仅只是单纯地重新诠释其实现!

③、使用描述性函数名称原则。详看命名规范。

④、少嵌套层级原则。代码中应注意不要嵌套太多层级,如if(){}else{},不可嵌套太多,应掌握一些技巧减少层级的嵌套。

反例:

if (a == 1) {
  b = 2;
} else {
  b = 3;
}

正例:

b = a == 1 ? 2 : 3;

  在正例中,我们使用三目运算符减少了层级的嵌套,这样既节省了代码,又变得美观,容易阅读。

⑤、尽快返回结果原则。

反例:

if(a==1)
{
    if(b==1)
    {
        doSuccess(message);
    }else
    {
        doError(message,b);
    }
}else
{
    doError(message);
}

正例:

if(!(a==1&&b==1))
{
    doError(message);
    return;
}
if(b!=1)
{
    doError(message,b);
    return;
}
doSuccess(message);

  在正例的代码中我们能看到,原本嵌套两级的代码改成了只有一级的层级,整体的整洁性提高了不少,而且逻辑思路变得很清晰。我们在书写代码的过程中一定要注意优化此类问题。

⑥、少入参量原则:函数应尽量减少参数的数量,理想是零参数,1-3个参数就可较为整洁,如果参数较多的话建议用传model的方式。

⑦、出参不为null原则:相信任何一个程序员都接触过【未将对象引用至实例】的问题,在返回实体、datatable或dataset等对象时,要注意检查是否会为null,要不然用户体验度就会变得很差。

  总之,代码整洁之道在于程序员本身,良好的编程习惯造就良好的代码质量,在漫漫码农之路上,我们要规范好自己,不给自己及他人留坑,不要让别人在背后骂我们“这是哪个傻X写的代码”,整洁的代码之道,才是程序员的核心之道!

猜你喜欢

转载自www.cnblogs.com/hongxuquan/p/9267701.html