编写干净的代码不是一件容易的事,它需要尝试不同的技术和实践。作为开发人员,编写干净的代码非常重要。首先列举一些编写干净代码的好处,然后提出6种编写干净代码的技巧,供开发者借鉴。从编写干净代码开始的好处让我们首先看一下编写干净代码的一些好处。主要好处之一是干净的代码减少了阅读和理解代码所花费的时间。混乱的代码会拖慢任何开发人员的速度,并使开发人员的工作更加困难。代码越混乱,开发人员就需要花费更多的时间来完全理解它才能使用它。而且,如果代码太乱,开发人员可能会决定停止阅读代码并自己从头开始编写。1.更容易开始和继续一个项目让我用一个简单的例子来说明这一点。假设我们在很长一段时间后回到以前的项目,也许在这段时间里有客户找我们找另一份工作。现在,想象一下,如果当时没有编写干净的代码,第一眼看到它会有多糟糕和混乱。此外,可以看出从中断的地方开始编码是多么困难。所以现在必须在项目上花费更多时间,因为我们需要理解之前编写的代码。这本可以通过首先编写干净的代码来避免,但现在你必须为此付出代价。此外,旧代码非常混乱和糟糕,我们可能决定从头开始。客户可能不高兴听到这些消息。另一方面,干净的代码通常没有这个问题。假设前面的例子反过来,前面的代码干净优雅,需要多长时间才能看懂?也许只需要阅读几分钟代码就可以理解它是如何工作的,而且我们可能已经编写了一段时间,所以这种情况下花费的精力会明显少于第一种情况,同时时间,客户不会太在意。这是编写干净代码的第一个好处,这不仅适用于自己的项目,也适用于其他开发人员的工作。干净的代码可以更快地开始工作,没有人需要花费数小时研究代码,我们可以直接投入工作。2.对入职团队有好处编写干净代码的另一个好处与第一个密切相关,它使新员工更容易、更快地使用代码。假设我们需要聘请一名开发人员,她需要多长时间才能理解代码并学会使用它?当然这要视情况而定。如果我们的代码乱七八糟,写得不好,她就需要花更多的时间学习编码。另一方面,如果代码干净、可读且易于理解,她将能够更快地开始工作。有些人可能会说这不是问题,因为其他开发人员可以帮助她。这当然是对的,但帮助应该是短时间的,两三次或一两天,而不是两三周。因此,决定聘请另一名开发人员是为了加快我们的工作速度,而不是放慢速度,或者花更多时间帮助她学习使用代码。当我们努力编写干净的代码时,其他人会向我们学习,效仿也会变得更容易。当然,还是需要留出一些时间来帮助每个新开发者学习和理解代码。当然,我指的是几天,而不是几周。此外,干净的代码将帮助团队引入更多的开发人员,同时帮助他们理解代码。简单来说,代码越简洁,越容易解释,误解也越少。3.更容易遵循编码模式要记住一件事,理解和学习如何使用代码又是一回事。然而,这仅仅是开始,我们需要确保开发人员愿意遵循我们的编码模式。当然,这个目标用干净的代码比用乱七八糟的代码更容易实现。这很重要,因为团队不仅要编写干净的代码,还要保持这种模式,这也需要长期思考。另外,如果开发人员不遵循当前的编码模式怎么办?此问题通常会自行解决。假设有一群人在同一个代码库上工作,其中一个人开始偏离标准风格。然后团队的其他成员将推动该开发人员遵循标准。她会接受建议,因为她不想离开团队。还有一种情况是开发人员说服团队的其他成员采用并遵循他自己的编码模式。如果开发人员想出更清晰的编码模式来获得更好的结果,那当然是一件好事。确实,编写和维护干净的代码并不意味着应该忽略任何改进它的机会,我认为人们应该始终对当前的做法保持一种改进的态度,并努力寻找改进的机会。因此,如果开发人员偏离了当前模型,而她的模型更好,那么我们进行更改可能更合适。所以在尝试其他模式之前,不应忽视其他人的编码实践,我们应该继续寻找改进的空间。最后是第三种情况。开发商决定既不采用我们的做法,也不说服我们采用她的做法。因为她将决定离开球队。技巧现在,除了讨论编写干净代码的好处之外,是时候学习一些技巧来帮助我们实现这个目标了。正如下面将看到的,干净的代码包含并遵循某些方法。这些方法使代码更清晰、更易读、更易于理解和更简单。当然,没有必要把所有的方法都实施,实施和遵循一两项措施就足以带来积极的结果。1.编写可读代码我们写的代码确实会被机器解释,但这并不意味着代码的可读性和可理解性就应该被忽略,因为将来总会有另一个人使用我们的代码写了。即使我们让其他人无法访问我们的代码,我们可能会在未来重新拾取它。由于这些原因,使代码易于阅读和理解符合我们自己的利益。又怎样?最简单的方法是使用空格。代码可以在发布前缩小,但没有必要让代码看起来缩小。相反,使用缩进、换行符和空行来使您的代码更具可读性。当您决定采用这种方式时,代码的可读性和可理解性会显着提高。然后,通过查看代码更容易理解它2.为变量、函数和方法使用有意义的名称让我们看一下第二个技巧,它将帮助我们编写易于理解和干净的代码。这个技巧是关于变量、函数和方法的有意义的名称。“有意义”是什么意思?一个有意义的名字是一个足够具有描述性的名字,而不仅仅是一个只有作者才能理解的变量、函数或方法。换句话说,名称本身应该根据变量、函数或方法是什么以及如何使用来定义。//Badconstfnm='Tom';constlnm='Hanks'constx=31;constl=lstnm.length;constboo=false;constcurr=true;constsfn='记住名字';constdbl=['1984','1987','1989','1991'].map((i)=>{returni*2;});//BetterconstfirstName='Tom';constlastName='Hanks'constage=31;constlastNameLength=lastName.length;constisComplete=false;constisCurrentlyActive=true;constsongFileName='记住名字';constyearsDoubled=['1984','1987','1989','1991']。map((year)=>{returnyear*2;});但是,需要注意的是,使用描述性名称并不意味着可以使用任意多个字符。一个好的经验法则是将名称限制在3或4个单词以内。如果需要使用超过4个字,就意味着这个函数或方法需要同时执行很多任务,所以应该简化代码,只使用必要的字符。3.使一个函数或方法只执行一项任务当你开始编写代码时,使用看起来像瑞士军刀几乎可以处理任何事情的函数和方法,但很难找到一个好名字。此外,除了作者之外,几乎没有人知道函数的作用或使用方法。有时我会遇到这些问题,而且我很不擅长。于是,有人提出了一个很好的建议:让每个函数或方法只执行一个任务。这个简单的建议改变了一切,帮助我编写了干净的代码,至少比以前更干净了。从那以后,其他人终于可以看懂我的代码了,或者说不需要再像以前那样花那么多时间去理解代码了,功能和方法也变得更好理解了。给定相同的输入,总是产生相同的输出,并且命名更容易。如果您很难为您的函数和方法找到描述性名称,或者需要编写冗长的说明以便其他人可以使用它们,请考虑这个让每个函数或方法只执行一项任务的建议。如果你的功能和方法看起来像一把万能的瑞士军刀,请实现这个方法,相信我,这种多功能性不是优势。这是一个相当不利的情况,可能会适得其反。旁注:这种让每个函数或方法只执行一项任务的做法称为保持函数纯净。这种编码实践来自函数式编程的概念。4.更容易遵循编码模式无论您如何努力为变量、函数和方法起一个有意义的名称,代码仍然不是完全清晰易懂的,仍然有一些思路需要解释.问题可能不是代码难以理解或使用,而是其他人可能不理解为什么要实现此功能或方法,或者为什么以特定方式创建它。意思是,创建函数或方法的意图不明确。有时你可能不得不对一个问题采取非常规的方法,因为没有足够的时间想出更好的解决方案,这也很难用代码来解释。所以,代码注释可以帮助解决这个问题,它可以帮助我们向其他人解释我们为什么要写这个方法,为什么我们要这样写,这样其他人就不必猜测这些方法或函数是干什么用的。更重要的是,当我们使用注解来解释代码时,其他人可能会找到更好的方法来解决问题并改进代码。这是可能的,因为他们知道问题是什么以及期望的结果是什么。没有这些信息,其他人将很难创建更好的解决方案,或者他们可能不会尝试,因为他们认为没有必要修改创建者自己的想法。因此,每当您决定使用一些快速修复或非传统方法时,请使用评论来解释您这样做的原因。最好用一两条评论来解释它,而不是让其他人猜测。也就是说,我们应该只在必要时使用注释,而不是解释糟糕的代码。写没完没了的注释无助于将糟糕的代码变成干净的代码。如果代码不好,应该通过改进代码来修复,而不是添加一些关于如何使用它的说明。编写干净的代码更为重要。5.保持代码风格一致当我们有一种特定的编码风格或我们喜欢的风格时,我们会在任何地方使用它。但是在不同的项目中使用不同的编码风格并不是一个好主意,自然也不可能回到以前的代码,所以还是需要一些时间来了解项目中使用的编码风格。最好的方法是选择一种编码风格并在所有项目中坚持使用。这样,回到旧代码会更容易。当然,尝试新的编码方式是一件好事,它可以帮助我们找到更好的工作方式。但是最好在不同的实验项目或练习中尝试不同的编码风格,而不是在主项目上。此外,当我们决定做一些实验时,我们应该尝试很多练习,并花时间把它做透。只有当你真的相信你喜欢它并且对它感到满意时,你才应该实施它。当决定这样做时,最好将其应用于所有项目。是的,这需要时间,也迫使我们正确思考。6.检查你的代码这是最后一个提示。这不仅仅是编写干净的代码,最终的工作是维护干净的代码。我们应该定期审查代码并尝试改进它。否则,如果我们的旧代码不经过审查和更新,它很快就会过时,就像我们的设备一样。如果你想让你的代码保持最佳状态,你需要定期更新它们。您每天使用的代码也是如此。代码会变得更加复杂和凌乱,所以应该避免这种情况,保持代码的整洁。实现这一目标的唯一方法是定期审查我们的代码。换句话说,我们需要保留它。对于你以后不再关心的项目,这可能没有必要,但对于其他人来说,维护代码是工作的一部分。最后这六种做法,可能不是最有影响力的,也可能不是最重要的,但这些是经验丰富的开发人员最常提到的,这就是我选择它们的原因。我希望这些实践或技巧能帮助您开始编写干净的代码。现在,与所有事情一样,最重要的是开始。因此,至少选择一种技术并尝试一下。
