专栏首页java思维导图编程中,有哪些好的习惯一开始就值得坚持?

编程中,有哪些好的习惯一开始就值得坚持?

转自:苏格拉大魔王

说一些基础的、适用于初学者的好习惯。

#1 - 在开始编码之前先规划和组织代码

在项目的开始阶段,不要上手直接写代码,一定要先确定代码的分层和架构。该分层和架构在一定程度上决定了未来整个项目的代码风格和维护性,对于项目的长期维护,代码架构的设计是一件非常重要的事情。

代码架构可以提供更好的可读性和可维护性。

大家可能还记得刚开始写代码的时候,所有的代码都会集中在一个文件,甚至一个函数中,比如:

随着需求的增长,代码量的扩大,这样的代码是很难阅读和进行维护的,于是我们会使用重构的手段去让代码更便于维护和阅读:

进一步,我们将代码分散在不同的文件、文件夹中,通过良好的命名,我们甚至可以在不去看具体的代码实现的情况下,仅仅通过文件名就能判断出在做的事情:

│ main.c│├───job│ first.c│ second.c│ third.c│└───otherother file

就文件来说,可以从文件名上,分清哪些是头文件、哪些是源文件、哪些是第三方库、还有各种功能模块的细分等。

就代码来说,包括统一的命名风格,封装在同一个文件里的代码的相关性足够强等。

一个好的架构还应该尽可能的提高代码的可扩展性。

你要知道需求变更太TM正常了,新增需求也太TM正常了。因此好的架构,必须要考虑到这些情况的发生,因为他们是一定会发生的。 所以,一定要避免把代码写死。

#2 - 避免大块重复代码,小块也不行

一个非常好的编程习惯是确保为代码创建函数或类,以便有时重用。当你的编码过程中多次出现重复的代码块,这样很臃肿、很鸡肋,你就应该想他们是否应该封装成一个函数或类。

专门为可以反复使用的功能构建专用文件。例如,数据库调用(例如打开数据库连接,选择数据,插入数据,更新数据,删除数据和关闭连接)都应该转换为函数。通过不必重写冗余代码行,也会使你的工作变得更加容易。你需要做的就是调用该函数,简单、清洁、而且容易。

例如,以下是将记录插入MySQL数据库的PHP函数示例:

#3 - 使用易于阅读的命名约定

无论你正在开发什么类型的代码,命名约定都很重要。你创建的变量名称,函数名称,类名称和任何其他程序名称越人性化,你后续的开发和引用就会越容易。因为所有代码并不都是同一天写的,而且一个项目往往由很多人共同参与,好的命名约定可以大大提高编码效率,还可以降低你在同事心中的傻逼程度。

例如,不是写这个:

而是应该这样写:

#4 - 注释所有代码,即使它看起来很明显

就算它写在脸上,也一定要注释、注释、注释。因为当你正在处理代码的时候,它肯定是易懂的,不然你也写不出来这样的代码。但是,当你再次回到该代码时,你可能

而且这也会大大减轻同事的负担,换位思考一下,假如老大让你改一下同事A没有注释的代码,可能改一下只需要2个小时,看懂得两天,你心里肯定万匹草泥马奔腾。

特别是如果该代码中有大量嵌套元素。对这样的代码块的右括号进行注释也是一种好习惯。

#5 - 在构建时测试和调试代码

每次创建代码块时,都应该对其进行测试和调试,以确保它正常工作。不要蒙头就是写,然后写完了之后在调试,避免为了找到错误而筛选数百或数千行代码。不仅需要在构建代码时测试和调试代码,还需要确保打开所有错误报告,以便在实际操作中实际查看错误。比如PHP,你还需要确保在php.ini文件或user.ini文件中打开这些设置,该文件通常位于根目录中。

在代码的顶部,应该使用:

在php.ini或user.ini文件中,应该修改以下语句:

#6 - 实现版本控制系统

版本控制是编程的一个重要方面。当你构建一个简单的软件时,你可能不会在一开始就考虑版本控制。但是,随着时间的推移,你将需要改进该代码,无论它是什么类型的代码。而且,随着你的改进,你将需要跟踪你的版本。请记住,编程不只是编写代码行,你必须能够正确地组织代码并跟踪你的工作。

保留版本也是很好的,这样你就可以不时地检查一下,看看你在之前的版本中做了什么,或者可能带回你在先前版本中删除但现在想要重用部分的代码。这是一个很好的习惯。因此,你需要一个可以控制版本的工具比如git。

#7- 多吃枸杞,养生、护发、防猝死。

本文分享自微信公众号 - java思维导图(java-mindmap)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-05-06

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 程序员,请优先提高代码的可读性

    现在,当有人提及“优化”一词时,他们通常是指“优化执行时间”,除非他们明确表明要优化GPU的内存消耗,网络流量等等。

    java思维导图
  • 自下向上的编写容易阅读的代码(上)

    我在 关于极简编程的思考 中曾提到要编写可阅读的代码。因为代码是编写一次,阅读多次。 阅读者包括代码编写者,以及后来的维护人员。能让阅读代码更轻松,有利于增强项...

    java思维导图
  • 如何写出让同事无法维护的代码?

    总之,我们的口号是—— Write Everywhere, Read Nowhere

    java思维导图
  • 我是如何学习写代码的?v2

    「 代码 」对于我来说,如同「 设计 」一样,都是为了「 创造 」 出某种产品的一种手段。

    mixlab
  • 程序员的5种类型

    在我的代码旅程和编程经历中,已经遭遇很多奇特的对手,还有更为奇特的盟友。我至少发现有5种代码勇士,有些是出色的战友,其他则似乎都在搅黄我的每个计划。 不过他们都...

    企鹅号小编
  • 论编程的最后期限

    普通编程与专业编程之间有很多差别,而最为显著的就是截止日期。 截止日期 / 最后期限   当你给自己写程序的时候,只要你愿意,就可以用很多(或者很少)的时间来...

    用户1289394
  • 从条件运算符说起,反思什么是好代码

    那什么样的代码才是优秀的代码呢?对于这个问题,我想每个人心中都会有自己的答案。今天我就来和你聊聊我的思考。

    架构师修炼
  • 高级Python工程师教你如何正确写代码

    我接手的第一样东西就是React UI。我们有一个主要组件,它容纳了其他所有组件。我喜欢在代码中加入一点幽默感,我想把它命名为GodComponent。在cod...

    小小科
  • Dead Code为什么能在代码库中永生?

    在一些遗留系统中,经常会看到大片大片灰掉的代码(被注释掉了),这种代码是死代码吗?如果要我下定义,我认为这些不是死代码,因为它们连代码都称不上,如何又能叫死代码...

    袁慎建@ThoughtWorks
  • JS逆向时碰到了恶心的死代码怎么办?手把手教你解决!

    你是否也曾有过「跟着代码跳了很久之后,才发现那一大坨代码其实没有任何作用」的惨痛经历?

    青南

扫码关注云+社区

领取腾讯云代金券