📜  向伟大的开发人员学习的 14 条重要编码规则

📅  最后修改于: 2021-10-19 06:13:57             🧑  作者: Mango

如果您从未编码过,那么您可能会认为软件开发就是用某些语言编写一堆代码行,然后在准备好时将其发布到生产级别。嗯,这是真的,但部分是这样。

向伟大的开发人员学习的 14 条重要编码规则

询问开发人员他们在日常工作中的实际工作?他们如何编写代码以及他们在构建某些功能时需要注意哪些隐藏规则。除了编写代码之外,开发人员还需要遵循许多不成文的规则。甚至他们的心情也可以通过他们在应用程序中编写的一段代码来识别。

请记住,编程不仅仅是解决问题并使您的功能正常工作。您还必须照顾很多事情。如何命名变量,如何使用循环、条件语句、注释等。如何记录、调试和测试应用程序。这些是只有开发人员及其团队知道的一些职责。客户或最终用户完全不知道这一点,但是当要在市场上成功推出软件时,这些重要因素非常重要。

现在我们有一些问题要问你……

如果应用程序没有经过适当的测试并且在用户使用它时出现故障,会发生什么情况?

如果一个新开发人员不得不处理其他开发人员编写的一些代码,并且他/她仅仅因为代码的复杂性而感到困惑,会发生什么?显然,他/她将花费更多时间或无法继续。

以前从未编码过的人总是不知道这些问题及其解决方案。在本博客中,我们将讨论这些问题以及开发人员应遵循的软件开发的一些重要方面。

1. 保持一致

在您的应用程序中遵循一致的编码标准。无论您遵循何种结构或方法,请确保在整个应用程序中与其保持一致。如果您在一个地方遵循一种方式做某事,那么在其他地方也遵循类似的方式。这将使您的代码更具可读性和可维护性。

例如:如果您在应用程序中命名诸如 variableOne、variableTwo 之类的变量,那么在其他地方遵循类似的方式。对于第三个变量,名称应该是 variableThree 而不是 variable_three。照顾好这些小事。

编码标准应该与变量的命名约定一样小。您的应用程序的结构应该尽可能简单,以便其他开发人员可以轻松地对其进行处理、添加功能并对其进行更改。

2. 减少嵌套

很多时候开发人员在他们的代码中编写嵌套语句。例如……在另一个 if 语句中编写 if 语句或在另一个 if-else 语句中编写 if-else 语句。很多时候阅读和理解代码会变得非常混乱。由于代码的嵌套结构,您的应用程序变得复杂和混乱。

如果您发现需要编写嵌套语句,请遵循那里的保护子句方法。在这种方法中,您可以使用 return 语句或异常立即退出函数。

// Without a guard clause

if (accountBalance != null)
{
    if (getOrder != null)
    {
        if (getOrder != null.term == Term.Annually)
        {
            // term annually
        }
        else if (getOrder.term == Term.Monthly)
        {
            // term monthly
        }
        else
        {
            throw new InvalidEnumArgumentException(nameof(term));
        }
    }
    else
    {
        throw new ArgumentNullException(nameof(subscription));
    }
}
// With a guard clause
if (accountBalance ! == null)
{
        throw new ArgumentNullException(nameof(account));
}
if (getOrder != == null)
{
    throw new ArgumentNullException(nameof(order));
}
if (getOrder.term == Term.Annually)
{
    // term annually (return here)
}
if (getOrder.term== Term.Monthly)
{
    // term monthly (return here)
}
throw new InvalidEnumArgumentException(nameof(order.term));

3.缩小并考虑更大的图景

每当您开始处理一个项目时,您都需要缩小软件的图片。考虑更大的图景以分析应用程序的较小细节。这将帮助您了解软件的架构及其各种组件。

4. 在你的代码中命名事物

软件开发中最困难的部分之一是为每段代码选择一个相关的名称。您需要仔细注意变量、类或方法名称。例如:如果您正在构建某个项目,并在其中计算闰年,那么您可以将其命名为“leap_year”。看你代码的人肯定会知道你做了一些与leap_year相关的事情。

良好的命名约定对于提高代码的可读性很重要,它还可以减少不必要的注释行。

5. 高估

作为一名开发人员,您应该始终考虑到完成一项任务所需的时间比您预期的要长。在进行项目时,总是高估任务的时间安排。低估任务可能会在您的应用程序中产生技术债务。您将有时间使您的功能正常工作,但您没有时间使代码干净且可维护。

6. 文档和代码注释

许多开发人员避免评论代码或记录他们应用程序中的内容。他们认为这只是浪费时间,但事实并非如此。文档和注释对理解应用程序特定部分的作用有很大帮助。

当你评论你的代码时,它解释了你为什么做某事。当其他开发人员开始研究它时,他们会立即了解功能、模块或组件。他们很容易理解您的代码、对其进行处理并对其进行更改。

7. 删除不需要的代码

在开发中,大多数时候开发人员编写一些代码,然后他们注释掉大量的注释,只是因为他们对它不太自信。他们把他们留在那里,认为将来他们可能不得不使用那段代码。伟大的开发人员非常清楚代码的哪个特定部分在代码库中并不重要。版本控制是有目的的,优秀的开发人员有信心删除应用程序的坏部分。

8. 给代码审查一些时间

不要低估代码审查在软件开发中的重要性。优秀的开发人员总是花大量时间在代码审查上,他们知道如何帮助构建一个好的应用程序。下面是一些关于代码审查的好东西……

  • 您可以在错误造成软件中的一些主要问题之前及早发现错误
  • 您将节省您的时间,您将提高您的技能,您将学习一些好的做法。
  • 分享知识。
  • 软件设计和实现将保持一致。

为了获得最佳的代码审查过程,您可以遵循下面给出的一些实用技巧……

  • 如果您有一项风险较小的小任务,那么 1 名开发人员就足以审查代码。
  • 如果您的中等规模任务风险更大或涉及更多更改,那么 3-5 名开发人员可以审查代码,但其中一个应该是高级开发人员。
  • 如果您正在处理风险更高的任务/更改,请安排一次会议并与至少 3 位开发人员进行沟通。此外,其中一个应该是首席开发人员一起检查每条线并检查点。

9. 测试

许多开发人员避免测试,认为这是一个耗时的过程,但优秀的开发人员永远不会逃避测试。他们花时间编写一个好的测试,这有助于他们更有信心地扩展应用程序。此外,您还可以防止自己在软件中引入许多错误。

10. 专注于基础而不是语法

这是软件开发中最重要的学习内容之一。优秀的开发人员知道掌握基础知识比过分关注语言语法更重要。您将能够有效地发现问题。

当您掌握基本概念时,您将对问题和软件有更多的了解。这有助于在未来使用谷歌搜索您的问题并轻松检测错误。

11. 寻求谷歌的帮助

在 Google 上搜索问题并不是开发人员不好的标志。它很聪明,也提高了开发人员的生产力。优秀的开发人员是谷歌搜索和解决问题的专家。再次阅读第 4 条提示。熟悉基本概念的开发人员知道要搜索哪些Google 术语。

不要沉迷于学习语法。让谷歌成为你最好的朋友,专注于基础知识,它对谷歌搜索和获得所需的解决方案有很大帮助。

12.让它工作然后让它完美

很多时候开发人员过于关注让事情变得更漂亮。他们的注意力更多地转向它,而不是检查他们的代码是否正在运行。他们花了很多时间让事情变得完美,后来当他们执行他们的代码时,他们发现它不起作用。

作为一名开发人员,您花在使事情完美上的时间越多,您就越会发现软件中的不完美之处。当您处理某些任务时,首先要专注于使事情正常进行。完成此操作后,您就可以专注于使事情变得完美。

这种方法可以节省大量时间,您可以在使事情变得完美之前及早发现问题。如果您的代码或功能不起作用,那么将事情变得过于完美是没有意义的。

13. 提出问题

伟大的开发人员在提出问题时不会犹豫。每当他们不知道某事时,他们就会提出问题,即使是最简单的问题。提出问题对他们来说并不尴尬。他们对自己的能力充满信心,并且不会害怕提问。这些问题可能与技术或业务相关的问题有关。

提出问题可以消除所有的困惑,这是好奇心的表现,而不是无法做某事。

14. KISS(保持简单愚蠢)

许多开发人员编写复杂的代码只是为了炫耀他们有多聪明。事情其实恰恰相反。伟大的开发人员相信让事情变得简单而不是复杂。他们编写简单的代码,以便其他开发人员可以理解、修改和处理它。此外,在代码中保持简单可以使您的应用程序更具可读性和可维护性。

最后的想法

阅读以上所有要点后,您可能已经意识到软件开发不仅仅是编写代码和使事情工作。在处理某些应用程序时,有很多事情需要记住。牢记上述所有关键点,并在您的开发之旅中遵循它们。你一定会在你的职业生涯中取得进步。