想问一下大家平时写代码注释的习惯是怎么样的

[spoonwep]

尝试过一边写代码一边写注释，感觉非常乱，有什么提高写代码注释效率的方法吗

[PrideChung]

把写注释的时间用来起一个好的变量名

[sandtears]

窝一般习惯是每次写到 if 或者 for 语句的时候写几句简短的注释，写完比较麻烦的逻辑之后写一点注释。

至于那种对于整个函数、整个类的注释，就是某个参数干嘛的、某个返回值干嘛的的那些，一般是后期补的。

[chmlai]

把 stackoverflow 的地址贴上.

[chairuosen]

不写注释....变量名自解释

[yukirock]

先寫註釋或文檔，一邊寫一邊整理邏輯，最後再動筆寫代碼。

[palmers]

喜欢 行注释 注释别人的代码就使用段注释

[zhenghuiy]

@PrideChung 同意。但比较复杂的地方也会写一下注释

[TankyWoo]

Clean Code里说过，大意是：

写注释，因为自己的表达能力不够，无法用代码来表达意图

当然，也不是说不能写注释，适当的写注释不会太多，应该也不会导致乱吧。

[dorentus]

写 TODO 的时候可能会写解释性的注释简述实现方法，实现完了就删掉了。

[jsonline]

变量名+2048

[hourui]

用同样的风格对齐就行了, 视觉上的排版一致性, 能直接影响到视觉快乐度.
怎么排, 不用太在意, 排出风格, 排出个性即可.

[akfish]

找个Code Doc的生成工具（如doxygen），然后按这个工具的格式撸注释，一般而言主要着重注释类、方法、参数等接口性质的东西，养成习惯后，代码写完，API文档也有了。
具体实现代码也就在重要的地方意思下就行了，真的需要事无巨细详细说明的，还不如另外写design document。

当然，如果编程语言是类似CoffeeScript这种的，可以试试literal programming的注释风格，注释比代码还多，更像是写篇blog，中间插入代码块。
然后同样可以用工具生成页面，比如CoffeeScript的源代码全是这样搞的，生成的页面很清晰：
http://coffeescript.org/documentation/docs/coffee-script.html

[lm902]

用好的名字，例如用GetServerConfigurationInformation(credential, "usessl")，而不要用getconf(login, true)

[lightening]

不写注释，看不懂的代码就抽象成一个方法，起个好名字。

实在要说明，放在 git commit messages 里面。

[yangff]

c++
在class和namespace的"}"后面加上一个注释 " // namespace XXX" " // class XXX"
别的基本没有了。。

[jsonline]

@lm902 永远没有必要在变量名里加 information 等单词，因为所有的变量都是 information。
同理永远不要用 flag 命名一个 bool，因为所有的 bool 都是 flag。

[spoonwep]

@PrideChung
@chairuosen
@TankyWoo
@jsonline
@lightening
有时候公司会要求写代码注释，而且还有比例和格式的要求……

[spoonwep]

@yukirock 可以试试，我也比较喜欢有条有理一点

[spoonwep]

@akfish 好像是个很棒的工具，感谢推荐~赶紧去尝试一下

[spoonwep]

@lm902 这样好长啊