第一次写代码应该养成的良好代码习惯

原创
2021/12/13 11:28
阅读数 50

一、为什么从一开始就要养成编写注释

        编写注释的主要目的是阐述代码要做什么,以及是如何做的。在开发项目期间,你对各个部分如何协同工作了如指掌,但过段时间后,有些细节你可能不记得了。当然,你总是可以通过研究代码来确定各个部分的工作原理,但通过编写注释以清晰的自然语言对解决方案进行概述,可节省很多时间。

        要成为专业程序员或与其他程序员合作,就必须编写有意义的注释。当前,大多数软件是合作编写的,编写者可能是同一家公司的多名员工,也可能是众多致力于同一个开源项目的人员。训练有素的程序员都希望代码中包含注释,因此你最好从现在开始就在程序中添加描述性注释。

        作为新手,最值得养成的习惯之一就是在代码中编写清晰、简洁的注释。如果不确定是否要编写注释,就问问自己:在找到合理的解决方案之前,考虑了多个解决方案吗?如果答案是肯定的,就编写注释对你的解决方案进行说明吧。相比回过头去再添加注释,删除多余的注释要容易得多。

 

二、中外程序员对编好码的一些共识汇总



1、Beautiful is better than ugly.
优秀的程序员笃信代码可以编写得漂亮而优雅。编程是要解决问题的,设计良好、高效而漂亮的解决方案都会让其他看到你代码的程序员心生敬意。

2、Simple is better than complex.
如果有两个解决方案,一个简单、另一个复杂,但都行之有效,那就选择简单的解决方案。这样不仅编写的代码更容易维护,日后自己或者他人改进这些代码时也会更容易。

3、Complex is better than complicated.
现实是复杂的,往往有时候可能没有简单的解决方案。在这种情况下,就选择其中相对最简单可行的解决方案。

4、Readability counts.
即便是复杂的代码,也要让它易于理解,比如,编写合适准确的注释。

5、There should be one and preferably only one obvious way to do it.
如果让两名程序员去解决同一个问题,他们提供的解决方案应大致相同。这并不是说程序员编程没有创新创意,而恰恰相反。然而,大部分编程工作是使用常见解决方案来解决简单的小问题,
但这些小问题都包含在更庞大、更有创意空间的项目中。所以在你的程序中,各种具体细节对其他程序员来说都应易于理解。

6、Now is better than never.
终生来学习编程和编程的纷繁难懂之处,但这样你什么项目都完不成。不要企图编写完美无缺的代码,而是要先编写行之有效的代码,再决定是对其做逐步改进,还是转去编写新的代码。

 

--------------------------------------

版权声明:本文为【PythonJsGo】博主的原创文章,转载请附上原文出处链接及本声明。

博主主页:https://my.oschina.net/u/3375733

本篇文章同步在个人公众号:

 

展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
0 评论
0 收藏
0
分享
返回顶部
顶部