2,118 次浏览 发布于 由cst

养成编程的好习惯，真的很重要！

相信有许多同学刚接触写代码的时候，

和我当初一样，主要有以下3个坏习惯 ：

① 命名随意和不规范；
   怎么简单怎么来，就图省事（比如直接用a,b,c1,c2）；

② 代码不懂得模块化；
   好几个实现逻辑挤在一个方法里 且 代码层级缩进不清晰； 

③ 不写注释；
   觉得注释不重要不想花时间写，只在意代码的功能实现；（写时很舒畅，回看很懵逼）

这些坏习惯在日常的刷题、写小Demo时，不会有什么问题，但要是在稍微完整些的项目或团队开发中，会严重影响到代码质量和效率，本人曾因为图省事，不写注释且把实现逻辑都写在一个模块里，导致后面代码很难扩展、出Bug后找了大半天、代码阅读起来很费劲等问题，这种情况，写的时候倒是爽了，但可能过几天需要对此功能进行修改的时候，就会后悔了哈哈， 注释往往花的时间很少，但改Bug花的时间可能多出好几倍 。可以说是 “ 因小失大 ，以贪小利失其大利也 ”。

在我看来，写代码时，事先应做个流程设想，最好别直接开始写，有时间可以通过笔记写出大致流程，然后随着脑海的逻辑，比如写某功能及注释，可以边写边注释，也可以每写个模块立即补上注释，这样不仅提高了代码的可读性，也可能在注释过程中发现了问题，从而减少了出bug的概率，然后每写完一个模块，也应对它进行功能测试（除非你很有自信嘻嘻）。 要有“码出质量，码出高效”的目标，除非是项目很赶时间，这些模块做了多次很熟悉了，这时候可以适当只考虑功能实现，注释等有空再补。

我再说说注释方面，我认为也不能盲目写注释，比如没必要每行代码都写注释、注释不突出重点，这样会使阅读代码时混乱，所以简单的部分无需注释，毕竟一个好的代码，从它的命名中就能见名知意啦，当然这建立在有个规范的命名习惯。

好的注释真的带给我很多便利，有次在写一个论坛类项目时，中途停止了开发，那段时间考驾照去了，期间隔了1个多月没开发，拿到驾照后我立马想继续开发这个项目，但打开后傻愣了一会，忽然之间不知从何开始了，但没过半小时，我翻了翻之前的开发笔记，伴随着代码注释看，比如找某个模块时，不需要从代码中寻找英文关键词，只需将注意力集中在显眼的绿色中文注释块，便能很快找到，或者直接搜索中文关键词，不再担心忘记英文命名的关键词。我很快就上手了，很快就衔接上了开发点；有时候我也会把代码发给同学看，分享自己的想法，他们许多人拿到代码后，也很快能看懂我代码的实现逻辑。 这让我更加认同编程中有好的注释、好的编程习惯的重要性，也能让你编程水平提升得更快；

前言说的有点多，啰嗦了哈哈......编程的好习惯很重要，要怎么培养好这个习惯呢？首先，要认识到这个不是一天两天就能养成的，刚开始肯定不适应，觉得容易乱，所以你先要坚持一段时间，将这个习惯变为真正的习惯。

下面我说说2个常见的Java编程规范（均需见名知意）


包、类、变量、方法的命名：

  • 包名全部小写；
  • 类名首字母大写,其余组成词首字母依次大写； 例如 MyTest 、UserInfo
  • 变量名和方法名，采用驼峰命名法；例如： firstName 、myCamelCase 、myMethod
  • 常量名全部大写，例如：MAX_VALUE、PASSWORD

代码注释 规范

单行注释、多行注释

类、方法、 类的属性(成员变量) 的注释必须使用 Javadoc 规范

备注：注释大致是这样，可能每个公司或团队的注释规范也会有些改动，有些不同地方，很正常。就像我的注释风格，我是按IT大厂阿里巴巴的Java开发手册中的规范来写的，但大家的理念都是 “码出质量，码出高效”。下方是阿里巴巴Java开发手册的pdf版下载链接，建议下载学习看看。

下载 Java开发手册.pdf

今天就码这么多字了，改天有空我会继续完善的哈，有不足之处欢迎大家提出~

“养成编程的好习惯，真的很重要！”的43个回复

评论已关闭。