目录
说一些基础的、适用于初学者的好习惯。
#1 - 在开始编码之前先规划和组织代码
在项目的开始阶段,不要上手直接写代码,一定要先确定代码的分层和架构。该分层和架构在一定程度上决定了未来整个项目的代码风格和维护性,对于项目的长期维护,代码架构的设计是一件非常重要的事情。
代码架构可以提供更好的可读性和可维护性。
大家可能还记得刚开始写代码的时候,所有的代码都会集中在一个文件,甚至一个函数中,比如:
随着需求的增长,代码量的扩大,这样的代码是很难阅读和进行维护的,于是我们会使用重构的手段去让代码更便于维护和阅读:
进一步,我们将代码分散在不同的文件、文件夹中,通过良好的命名,我们甚至可以在不去看具体的代码实现的情况下,仅仅通过文件名就能判断出在做的事情:
│ main.c
│
├───job
│ first.c
│ second.c
│ third.c
│
└───other
other file
就文件来说,可以从文件名上,分清哪些是头文件、哪些是源文件、哪些是第三方库、还有各种功能模块的细分等。
就代码来说,包括统一的命名风格,封装在同一个文件里的代码的相关性足够强等。
一个好的架构还应该尽可能的提高代码的可扩展性。
你要知道需求变更太TM正常了,新增需求也太TM正常了。因此好的架构,必须要考虑到这些情况的发生,因为他们是一定会发生的。 所以,一定要避免把代码写死。
#2 - 避免大块重复代码,小块也不行
一个非常好的编程习惯是确保为代码创建函数或类,以便有时重用。当你的编码过程中多次出现重复的代码块,这样很臃肿、很鸡肋,你就应该想他们是否应该封装成一个函数或类。
专门为可以反复使用的功能构建专用文件。例如,数据库调用(例如打开数据库连接,选择数据,插入数据,更新数据,删除数据和关闭连接)都应该转换为函数。通过不必重写冗余代码行,也会使你的工作变得更加容易。你需要做的就是调用该函数,简单、清洁、而且容易。
例如,以下是将记录插入MySQL数据库的PHP函数示例:
#3 - 使用易于阅读的命名约定
无论你正在开发什么类型的代码,命名约定都很重要。你创建的变量名称,函数名称,类名称和任何其他程序名称越人性化,你后续的开发和引用就会越容易。因为所有代码并不都是同一天写的,而且一个项目往往由很多人共同参与,好的命名约定可以大大提高编码效率,还可以降低你在同事心中的傻逼程度。
例如,不是写这个:
而是应该这样写:
#4 - 注释所有代码,即使它看起来很明显
就算它写在脸上,也一定要注释、注释、注释。因为当你正在处理代码的时候,它肯定是易懂的,不然你也写不出来这样的代码。但是,当你再次回到该代码时,你可能
而且这也会大大减轻同事的负担,换位思考一下,假如老大让你改一下同事A没有注释的代码,可能改一下只需要2个小时,看懂得两天,你心里肯定万匹草泥马奔腾。
特别是如果该代码中有大量嵌套元素。对这样的代码块的右括号进行注释也是一种好习惯。
#5 - 在构建时测试和调试代码
每次创建代码块时,都应该对其进行测试和调试,以确保它正常工作。不要蒙头就是写,然后写完了之后在调试,避免为了找到错误而筛选数百或数千行代码。不仅需要在构建代码时测试和调试代码,还需要确保打开所有错误报告,以便在实际操作中实际查看错误。比如PHP,你还需要确保在php.ini文件或user.ini文件中打开这些设置,该文件通常位于根目录中。
在代码的顶部,应该使用:
在php.ini或user.ini文件中,应该修改以下语句:
#6 - 实现版本控制系统
版本控制是编程的一个重要方面。当你构建一个简单的软件时,你可能不会在一开始就考虑版本控制。但是,随着时间的推移,你将需要改进该代码,无论它是什么类型的代码。而且,随着你的改进,你将需要跟踪你的版本。请记住,编程不只是编写代码行,你必须能够正确地组织代码并跟踪你的工作。
保留版本也是很好的,这样你就可以不时地检查一下,看看你在之前的版本中做了什么,或者可能带回你在先前版本中删除但现在想要重用部分的代码。这是一个很好的习惯。因此,你需要一个可以控制版本的工具比如git。
#7- 多吃枸杞,养生、护发、防猝死。
链接:https://www.jianshu.com/p/cc470e862718