编码习惯建议

最新推荐文章于 2024-10-30 17:15:00 发布

IT艺术家-rookie

最新推荐文章于 2024-10-30 17:15:00 发布

阅读量101

点赞数

分类专栏：编程设计和习惯文章标签：经验分享

原文链接：https://medium.com/javascript-in-plain-english/19-things-i-stole-from-great-developers-85511ff56570

版权

编程设计和习惯专栏收录该内容

2 篇文章 0 订阅

订阅专栏

编码习惯建议

进行软件开发，整天敲代码、好不容易调试成功，但是代码的质量堪忧，可读性不是很高，反过头来还得对代码进行完善。也许这不是你的编码能力问题，很有可能在你进行代码编写时，一些看似不重要的编码注意事项没有遵守。这有一份高级开发人员经常遵循的 19 条原则，其中很多与实际编码无关，而是与流程以及如何处理任务有关，可能对你有帮助。

Rule Of Three 原则

这是一条代码重构的经验法则，用于决定何时将复制的代码段替换为新的代码 / 过程 / 方法。

它的含义是，第一次用到某个功能时，你写一个特定的解决方法；第二次又用到的时候，你拷贝上一次的代码；第三次出现的时候，你要着手「抽象化」，写出通用的解决方法。

该原则的主要思想是使代码 / 过程 / 方法更加通用，从而保证在其他地方可以重复使用。

应用程序结构与编码方式保持一致

应用程序结构与编码方式保持一致有助于提高其可读性和可维护性。

尝试制定编码标准，这有助于保持编码一致性。编码标准应该与变量的命名规则一样少。另一大问题是应用程序的结构，开发人员进行更改或添加新内容的地方应该很明显。

减少程序嵌套

if 里面嵌套 if 会使得程序很混乱，代码很难读。在编写代码时可能无法绕开这些问题，但你需要经常查看代码结构。

else if 同样如此，因此需要尽量避免嵌套。

一种有效的解决方法是卫语句：卫语句把复杂的条件表达式拆分成多个条件表达式。

不使用卫语句的编码方式：

if (account != null)
{
    if (order != null)
    {
        if (order.term == Term.Annually)
        {
            // term annually
        }
        else if (order.term == Term.Monthly)
        {
            // term monthly
        }
        else
        {
            throw new InvalidEnumArgumentException(nameof(term));
        }
    }
    else
    {
        throw new ArgumentNullException(nameof(subscription));
    }
}

使用卫语句的编码方式：

if (account == null)
{
        throw new ArgumentNullException(nameof(account));
}
if (order == null)
{
    throw new ArgumentNullException(nameof(order));
}
if (order.term == Term.Annually)
{
    // term annually (return here)
}
if (order.term == Term.Monthly)
{
    // term monthly (return here)
}
throw new InvalidEnumArgumentException

了解全局很重要

了解全局有助处理较小的细节。一旦了解了全局，你就不会花很长的时间在小细节上。

程序中的命名

在编程中进行命名是最困难的事情之一，包括为一个类、一个方法命名，甚至是为变量命名。优秀的开发人员会花时间考虑相关的命名方式，这样会增加程序的可读性。

减少技术负债

技术负债指开发人员为了加速软件开发，在应该采用最佳方案时进行了妥协，改用了短期内能加速软件开发的方案，从而在未来给自己带来的额外开发负担。这种技术上的选择就像一笔债务一样，虽然眼前看起来可以得到好处，但必须在未来偿还。软件工程师必须付出额外的时间和精力持续修复之前的妥协所造成的问题及副作用，或是进行重构，把架构改善为最佳实现方式。

对于技术负债问题，提高预估时间有助于解决这类问题。尽自己最大的努力写好代码，否则你将不断地进行代码完善。