【熟】代码美学：勿写注释

狐白白白白白白白白白:
你应该写的注释是你为什么要怎么做，而不是你在这里做什么

【回复】对，对于函数名要写做什么而不是怎么做[doge]
【回复】前提条件是你的代码能让人看懂你在做什么[笑哭]
【回复】你这样做毫无意义，时间长了，不要说别人，就算自己也有可能看不懂
当麻家的傲娇炮:
省流：要把代码写的像注释，而不是用注释去写代码

【回复】然后换来了越来越长的变量名和函数名[吃瓜]
【回复】回复 @当麻家的傲娇炮 :你也希望代码里出现像WebsiteHeaderImageDownloadUnconnectedInProcessError这样的变量名嘛[脱单doge]虽然说没办法
【回复】回复 @卢登斯的只言片语 :有ide之后函数长不是啥问题
JoeyhF:
第一天 我：我的代码只有我和上帝看得懂[歪嘴] 第二天 我：应该只有上帝看得懂我的代码了[藏狐]

【回复】回复 @气飞 :第四天 编译器（解释器）都看不懂我的代码了[doge]
【回复】第三天 我:现在上帝也看不懂我的代码了[doge]
【回复】第五天:我要送代码见上帝了
the-fool-man:
[doge]真正的原因是随便喊个新人没办法接替你，完美保住饭碗

【回复】[妙啊]只要我的代码像加密账本，就没人能取代我
【回复】回复 @___----_____ : 哈哈哈[笑哭]
DLM-Tamashii:
其实更主要的问题是很多公司的程序员同事英语水平令人堪忧，就算你代码写的再好，变量常量命名再规范，不加上注释他们也看不懂是干什么用的。

【回复】回复 @---MCSE--- :我维护我们公司之前的代码(用的还是jdk6),其中一个变量 String sex_男="01"；这玩意儿给我笑了两天
【回复】回复 @呆丸楠某丸 :让那些常用编程语言支持带汉字的变量和函数名差不多就可以了吧？ 而且感觉汉字体系真的比字母文字有天然的可读性优势。我英文水平算好的一档，平时读英文和母语一样流利。就算这样，如果要我在一篇文章里找一个词，永远是中文比英文快。这要是在代码里我能更快的检索出相关的变量和函数，而英文我却要在字母堆里找茬，甚至还得扣那几个s和后缀的字眼 而且汉字词性变化少，字符数量少。就算一个汉字占两个字节，两三个汉字占的空间也比一长串的字母少。汉字也没那么多词性，我改过外国人写的代码，我把一串英文名变量复制粘贴到另一段代码里，它给我报错，一看是这帮老外自己都搞不清楚词性，在粘贴过去的那段代码里那个变量名多了个-al后缀。更别说国人写的代码了，单复数不分，动名词乱用，还有拼音首字母，简直群魔乱舞 变量名可以用汉字，if else这种固定语句用英文，我感觉这种挺好的。大块头的字一看就知道是变量和函数，小个的字一看就知道是系统操作
马桶占神白首男:
自注释的代码当然是完美的，不过有几个人能写好呢

【回复】很多代码是基于数学算法，不写注释根本没法解释
【回复】回复 @农药白风 :fft优化💦💦 注释都不好解释，只能放个链接[大笑]
【回复】回复 @Blazing_Stellar :确实，我也做过。0x5c5c5c5c怎么解释
Slash_Bean:
就拿.net SDK举例，里面大多数类和方法注释都写的清清楚楚，调用的时候代码提示直接显示每个方法或参数的作用，省去了查文档的时间。这难道不方便吗

【回复】那个东西其实已经算文档了。///打头那种注释的大名就叫Documentation comments。而且这些内容本身也是解释用法一般不谈代码原理，和这个逼作者说的不冲突。
【回复】回复 @四谷ゆみP :这个作者起这种标题完全就是噱头，说一些模糊不清的话引起误会和矛盾，到最后说的跟注释p关系都没有
【回复】回复 @Anifold :标题党党魁是这样的，他这几个视频都是这样的[笑哭]
靠墙的钴-60:
对于著名的 i = 0x5f3759df - ( i >> 1 ); 不写注释真的能看懂嘛😂

【回复】注释了也看不懂啊[吃瓜][吃瓜]源代码的注释： i = 0x5f3759df - ( i >> 1 ); //What the fuck?
【回复】如果完整看了视频，就会发现这种代码属于作者说的需要注释的范畴。
【回复】作者的意思应该是使用适当的类型与命名等技巧已经能够使得一般逻辑的代码拥有足够的可读性，但是对于复杂的算法该写注释写注释，该上链接上链接
白白可乐_:
声明：我没有看内容，这个踩是给标题的。

【回复】你先看看内容，这个踩是给你的
【回复】回复 @ZhangHB_321688 :哈哈哈哈，给你点赞
【回复】回复 @Hax002F7A :我和视频的观点一致，不是百分百不要写注释，而是①写文档注释，②用变量和函数代替注释，③实在不行用注释解释原因，等等。 我也同意你的说法，说到底视频这个是比较理想的情况。个人项目风格统一、规模不大，可能可以保持这种美学；像windows这样无数人维护的大工程，代码水准参差不齐，难免需要注释来促进合作。然而这不妨碍视频里所说的技巧，成为一种提升代码质量的方向。 但层主只看了标题四个字就开始输出观点，显然是有失偏颇的，了解了视频在说什么之后，再发表批判，这样的批判才可能有深度有内容，否则就只是输出情绪而已，我想这也是这楼里这么多人反对层主的原因。
某江南的黎三金:
最讨厌的两件事： 1、读别人代码没注释 2、给自己代码写注释

【回复】自己写的代码过两天再看就像别人的[辣眼睛]
【回复】我只会注释我在这里做了什么事，但是要我注释怎么弄的，我是真做不到，为什么非得要注释的那么清楚，是生怕别人替代不了你嘛[笑哭]
RealBinger:
一些比较简单的逻辑，可以在代码非常简洁美观规范的情况下不写注释——因为简洁易懂。 然而我认为注释仍然很有必要，不是所有人都能写出很好的代码，他们使用注释能够确保后来人的维护。 注释还有一个好处：向后来人解释“为什么这样更好”，有利于学习、研究以及优化。 这期视频也是很有启发的——多好的注释也救不了垃圾的代码，规范的代码在某些方面比注释重要。

【回复】视频中还说到，经常会有修改代码后忘记同时修改注释的，导致不好维护的问题
不务正业的冯工:
泥马，我凌晨4点，睡不着又饿着。就刷视频，竟然还有6个人一起看。大家不要熬夜！熬夜伤身！易掉发！还伤肝！肝不好还会导致肾虚！

【回复】回覆 @四谷ゆみP :[偷笑][偷笑][偷笑]
MorganWhiskey:
clean code中有一章专门写了这个内容，核心的意思就是不要写不必要的注释 这只会干扰你阅读代码

【回复】尤其是两者会变得不一致的时候
【回复】回复 @Acd1ng : 不一致的时候是真滴难受，特别是那坨代码没看懂，读了注释后更加没懂
【回复】回复 @账号已注销 :那是真滴难受
Hongjun008:
代码写的够好，什么枚举或者宏定的好，变量名起的好那确实不用写注释

【回复】不可能，命名当然要简洁明了可读，但读的人可能有不同的理解导致误会（尤其在英语非母语的情况下），为此增加命名长度又会使代码十分冗长
【回复】简单项目还可以，复杂点还是得写注释
A路人贾:
我就特别喜欢写注释。公司一年不给涨工资，自己又一手写的私有组件库，组件写完了注释清楚，方便维护，自己就要开始担心某些问题了。干脆核心代码的注释简洁 一点 吧[tv_鬼脸]

【回复】如果你是c程序员，你在公司干得越久越不可能被辞退[doge]
【回复】回复 @鸽大可 :可惜我只是个写前端的[tv_鬼脸]c没怎么深入，最近考虑摸rust
【回复】回复 @鸽大可 :细说[doge]
白鸟苍:
事实上大部分库里的代码因为高层抽象，没有注释根本就看不懂他在这一层为什么要这么做。对于只是想使用api的人，只看文档当然足够，但是对于想阅读源码、参与开源开发的人来说，没有注释的代码显然是不合理的

amusingyyy:
理想很美好，但实际上复杂的工程没那么容易写漂亮，注释还是有必要的

Bili_361458634:
世界上最令人讨厌的两种人：不写注释的人，和让我写注释的人

阿卢说他遇到阿玮哔哔:
视频内容离标题相差太远了，讲解人只是说怎么写出更好的代码和没有及时更新注释会带来错误理解。 后者如同在说项目说明文档可能没更新，所以不应该信任文档一样。

张大炮-mi1itray_axe:
大项目真的写点注释，这是我看 nginx 源码得出来的感慨，还好有文档有开源社区，否则我杀了作者的心都有了