优秀的打工人是如何写注释的

当代优秀打工人是这样写代码注释的

写出好的、有意义的注释其实是有难度的，就像写代码一样。在追求卓越的路上，代码和注释其实是相辅相成的。注释会让你的代码更易阅读，代码会让你的注释更富有逻辑。

写注释的逻辑其实和写代码相似。在写代码之前，肯定要想好自己要实现什么功能，怎么实现，如果把这些作为注释写下来，一边巩固代码一边扩展思维，那么绝对会比你现在敲出来的代码更加优美。

作为一个晚出晚归的优秀打工人，想要敲出优秀的代码注释，先要明确注释都有什么类型，它们的意义在哪，才能对症下药，药到病除。

首先我们来探讨一下代码注释的分类。

在《代码大全》中，将注释分为了5个类别：

1、 代码的重复

用不同的词语，重申代码的内容

2、 解释代码

解释比较复杂的代码，这种类型的代码，往往可以通过代码的优化，使代码本身更清晰。当然，进度优先时，这类代码是有必要的，有利于今后的维护。

3、 标记型注释

//这里有必要做个优化

Or

//这里还没写完

经验表明，如果你这样写了，通常来说，这些事你都不会去做。这些事情，应该在提交代码前，就把它做完。

另外，这类注释最好要加上一些关键的信息，如姓名、日期、联系方式、提示等，方便grep。

4、 总结代码

将一整块代码总结为一句或两句话，这样的注释，能帮助他人快速理解代码。

5、 代码的意图

解释代码的目的，最初的编程意图是什么，打算解决什么难题？

事实证明，只有4和5，也就是总结代码和代码的意图这两类的注释最有效，也最能体现注释的作用。

换一种说法，它们的意义在于能够真正表明代码的作用，让人一目了然，去除无用的反复推敲，这才是真正意义上的好注释。

其次，让我们来聊聊敲注释时候的注意事项。

如果你是一名程序员小白，那么建议你从现在开始培养注释的习惯，每天都认认真真的写注释，时间一长你就会发现自己的思路更加清晰连贯了。

以后等到看的书多了，能看得懂并且记得住很多东西的时候，可以适当减少代码注释的比重。或者用你熟悉的方式代替复杂的语言，只要你能看得懂就好，不过记得要给以后的人留下阅读空间噢。

不要顾此失彼，过于重视代码注释，为了写一手漂亮注释甚至忽略了代码本身的重要性，这样当然是不对的。把代码写好、写漂亮，注释就可以更精炼，也必然能写得更加通俗易懂。

吐槽可以，但要适度。每天都在注释里写个小作文，你是开心了，那活还干不干了？记得合理作息，按时恰饭！

另外，如果没有特殊要求，或者就想锻炼自己的英文能力，答应我，你还是用中文写注释吧。

最后，我们来说说心态问题。

不要被某些言论误导了好伐！

那些说写注释没用的人，要么就比Java之父还要厉害，毕竟Java之父还在写注释，要么估计连编程软件都没打开过，可能还以为vscode是要和code battle一下呢。

注释难道是别人逼你写的吗？是你自己要主动写，为了让自己以后更轻松的好吧！

不要偷懒好伐！

听说注释经常会过期，因为代码经常会更新。所以这是不写注释的理由吗？都0202年了，代码都更新了，你还不更新下注释吗？不要找借口偷懒好吧！

工作只会越攒越多，麻烦你看完这篇文章之后，下午马上去更新注释！（暴躁小编，当场敲屏幕）

写在最后

之前看过一个帖子，提出了一个想象力十足的问题：当我把一段代码注释的时候，那段代码会不会害怕？

在这里告诉大家，当你注释一段代码的时候，那段代码会不会害怕我不知道，但是如果你现在还不写注释，以后你再看这段代码就肯定会害怕了。

还愣着干嘛？写注释去啊！

当代优秀打工人是这样写代码注释的