关于代码的一些心得体会（大神勿喷）

Posted 2020-09-27 lms_码农

关于代码的一些心得体会

  前  言

Lms

　　　入行也有很久了，一直都只是忙着工作学习，却一直没能好好静下心来好好整理一下自己。时间久了，慢慢的代码越来越熟悉，敲起来也越来越顺手，自己缺总感觉有些不对。我总觉得代码不应该就是这么简单，不应该像写记叙文一样，一条一条慢慢的就罗列出来了，返回去看了看自己刚写代码的时候功能也都能够实现了。但是还是有那么多可以优化的地方。我觉得好的代码不应该只是把功能实现那么简单，我觉得好的代码应该有以下几条特点：第一，命名要规范，第二，可复用性，第三，就是注释。当然，当然你们可能有更深入的理解，可以分享给我，这里，仅把我最近领悟的分享给大家。

 

一、 命名的规范

 　　最近，一直有看一些关于怎么优化代码的文章和博客，大多都有提到命名的规范和代码的可读性。说来惭愧，我醒悟的并不算太早，有挺长一段时间我的代码里充斥着var daa； var  mbb；等一些蜜汁缩写，有时翻出自己原来的代码来作复习和总结，看到这些东西总是最头疼的，因为自己已经忘了这是什么的缩写，是拼音还是英语，都早已不记得了。只能再次整理代码逻辑，找到这些东西到底是啥。

　　命名规范主要就是可读性，可读性高了将大大提高代码的质量，也会增加代码的可维护性。毕竟，维护代码首先要读懂代码。下面讲一下我对变量和函数命名的一些心得，看了许多文章，都在说要遵守某某法则，和使用标准的英文。我说下我的看法：

　　1、首先，命名确实需要一个好的命名规则，你可以使用驼峰法则，匈牙利命名法等等，这会让名字看起来清晰一些，毕竟不能用空格隔断单词。

　　2、关于英语命名，如果你英语好的话，我建议你是用标准的英文来命名，如果你英语不好的话我建议你使用拼音。总有人在说程序员使用拼音很土，很low，可我想不明白，中华民族的拼音low在哪了，难道就连个代码命名都要崇洋媚外么。当然，笔者英语比较差，我承认，所以别人这么说我的时候有些反感。我觉得拼音挺好的，至少在国内的话，程序员英语差的不在少数。当然，你想写出国际化的代码，走向世界，就当我在放屁。

　　3、使用缩写的时候，请在你第一次使用这个块的缩写时，在前面注释一下这个缩写是啥意思，为以后的读取大开方便之门，毕竟你注释只需要一点点时间，但是，不写注释等你再用到去翻看的时候会用到几倍甚至几十倍的时间。

 

二、可复用性

　　我觉得，写的好的代码是下次拿过来就能用的。这里的可复用性我有两种理解，

　　　　第一种可复用性就是这段代码会在这个程序或是工程里经常出现所以把它提出去。封装起来，哪里需要哪里调用即可。

　　　　第二种可复用性就是写了一个很常用的功能，在别的工程也用到的时候直接拿过来就可以使用的，也就是平时我们用的插件。

　　下面，举个例子：

　　1、首先，要实现一个信息循环滚动的功能：

·　　2、然后你可以把它写成这种，基本的功能都已经实现了，并没有哪里不对，请接着往下看

　　　3、随着你的不断进步，你会发现代码还可以继续优化然后变成下边的样子。

 　　4、技术不断提高，眼界的开阔，优质源码的阅读，你会发现原来的代码还可以进一步优化，然后变成了插件

 

三、 注释

　　首先，我们看一下注释的重要性，先看一下几种假设，请带入一下：

　　　　1、当你经过一段时间后，发现哪儿出问题或需要调整功能的时候；

　　　　2、当你去改别人代码的时候（你的代码也会被别人改）；

　　　　3、当你需要补一些设计文档的时候（比如现在的我）；

　　　　注：以上的这些情景仅发生在：1、你所面对的是别人的代码；2、如果你面对的是你的代码，再加一个前提，过一段时间之后。 

　　然后，我总结了一下我们在注释中常出现的问题，大家共勉：

　　　　1、忘记写注释：a、这种情况大多数是只写了方法本身功能注释，但是参数的含义并未加以说明(再遇到参数取名和本身含义更不符的情况下，就更头疼了)；

　　　　　　　　　　　  b、有些就直接类和方法注释都没有（少数）

　　　　2、注释描述的不够清楚、太简单笼统话：一些类或方法注释太过于简单笼统，不能准确表达代码含义。

　　　　3、注释与本身代码所做的功能不符合：总结发生的情况可能有如下原因：

　　　　　　a、写好一个方法或类，复制粘贴的时候把注释一起复制粘贴，完了后代码改了（代码有错误提示）忘了改注释（注释没有错误提示），导致注释与代码不符；

　　　　　　b、一些方法参数，可能实现设计的时候没有，或者多设计了，后来经过反复修改，参数进行了调整，这时参数的注释还是以前初始版本，这种情况也是只注重代码，注释未得到及时的更新，导致注释与代码严重不符；

　　最后，关于怎么做好注释我写下我的理解：

　　　　1、一定要养成良好的代码注释习惯，边写代码边注释，及时的记录下自己写代码过程中的思路；

　　　　2、一定要养成代码和注释同时对待，改完代码及时更正注释；

　　　　3、多提升自己对代码的解释能力，用精炼的语言表达出代码的核心价值所在；不要用冗杂的语言描述，看起来注释比代码还多。

 

 

　　关于怎么写出更好的代码我也在进步的路上，在此写出此篇文章大家共勉。大家都有不同的意见欢迎指教讨论，大家一起进步。最后谢谢大家的阅读。