大家注释怎么写的

[brucefeng]

最近团队开始有新人进入，在写代码注释上，有一些不同点。之前团队提倡的是尽量少写注释，让代码有自说明的作用，如果实在无法通过代码表达，再在接口 /方法级别写注释，其他地方不再多加注释了。

新人的注释习惯比较多，有的系统对关键代码行写步骤注释，有些接口和实现都有注释，有时候注释太多，感觉影响代码。

问问大家都是怎么写的。

[rashawn]

代码里注释写的少 git commit 的时候写详细一点 都干了啥 怎么干的也可以啊

[penjianfeng]

没有注释的代码都不是好代码,说什么少些不写代码的你去当下接盘侠就知道什么叫做 f**k 了狗的感觉了

[nellace]

讨厌看没有注释的代码

然而自己也不怎么写。。。。。

[kisnows]

当接手别人的代码的时候，就知道不写注释有多么坑了。你需要花很多时间来理解前人的一些‘小技巧’，代码自注释太理想了，即使他命名非常规范，但你要理解一段代码内容还是得把多有的代码读一遍，如果有注释了，那就能节约很多时间了。

[ango]

注释两个标准：
1 、方法 /类，头声明注释；
1.1 如果有必要，注释需要添加使用实例；
1.2 如果为接口类，需要把 wiki 相应的文档地址注释上去。

2 、代码块注释，注释必须与代码分行写，不可写于代码末尾；
2.1 简单写步骤说明。
2.2 算法逻辑简要说明。（或者计算公式）


良好的编码习惯是很重要的，不要为简而简。（多年前实习的时候，某位前辈教的）

[sfree2005]

让别人可以快速看懂你的代码，除了注释和代码本身的简洁明了之外，还有测试。单元测试可以说是将说明和例子结合到一块了。就像查字典，解释下面跟着就是例句了。

[ajan]

基本不写注释。。。

[unknownservice]

// 宫保鸡丁
鱼香肉丝

[zealotpz]

/**
* 没注释给你看
* 好不容易写出来的
* 你花点力气看也是应该的
*/

[YzSama]

注释必须写。
虽然麻烦点，但是为了自己也为了别人。

[aksoft]

头回听说注释会影响代码。。

[xylophone21]

两种情况下写注释：
1. API ，别人看不到你的实现或者懒的看，不方便看等情况
2. 坏味道代码，各种临时实现，其它模块的 Bug ，深坑，奇怪的需求等等，注释到这以后再改。

其它注释一般来说不主动，不表态，不拒绝

[octopole]

注释有一个点很重要，你我都能看得懂，不觉的多余，刚刚好需要。

[wmhx]

函数和重要的变量是要有注释的, 其他无所谓了.

[8023]

个人习惯把注释写的非常详细, 也是因为我刚开始学写程序时英语水平不好变量名函数名类名都是各种拼音简写甚至"一个变量""又一个变量"的拼音, 如果不写注释的话以后看起来很麻烦. 现在因为水平的逐步提高, 命名规则也逐渐走上正轨, 注释的习惯却保留了下来. 每一个函数的编写日期, 实现功能, 参数说明, 甚至还包括如何调用(何时会调用, 如何调用的例子)... 变量在哪里用到之类的. 几乎是每行都加注释. 已经成了习惯... 然而我只是自己写着玩儿或者说是学习, 还没工作.

[haozina]

拿到一个 9 年前的项目做升级，注释太少看得太痛苦，业务还很复杂。

[stormpeach]

@XDDD 嗯，但是有时候一些状态码会需要很长的解释

[ericpeng]

代码自说明适合一个人独立的 web 项目（纯 web 逻辑不复杂）。

一个大项目包含数十个小项目，每个小项目数十万行代码，不写注释，依靠自说明就完了。

顶级大牛的代码都是注释特别多（如同使用文档，减少沟通成本），代码特别精简（写注释的过程就是梳理思路的过程，会重构代码）。参考顶级项目的源码。

[ericpeng]

我接手的某公有云的代码，不写注释看得很累，各种小的设计 trick ，每次都要找到原来的作者才能理解，而且还不合理，浪费大量时间。每个小项目都是多个人经手，每个接盘侠都要骂前面的作者；为了不让下一个接盘侠骂自己，我还是好好写注释和重构代码。

[franklinyu]

@8023 編寫日期可以交給版本控制系統；參數說明、調用方法和例子等信息，應該寫入「文檔」而不是註釋。