注释写得太多了会挨打吗？

2018-09-25 17:26:16 +08:00
 fundebug

16276 次点击
所在节点    程序员
145 条回复
nikymaco
2018-09-26 17:03:38 +08:00
这个注释写得挺好。把参数来意，方法逻辑在规范的地方写上了特别有助于团队开发。如果是写过多注释在方法体内就变成除臭剂了，这样就不太好了，代码阅读起来费劲。不过这一切都是团队一起规范起来才行，方法体有变更就要即时更新注释，特别是有些家伙改了你的东西没有即时更新，那就操蛋了，哈哈。
swim2sun
2018-09-26 17:05:06 +08:00
建议不嫌注释多的看看《 clean code 》。
注释维护起来是比较麻烦的，一旦代码改了注释没同步更改，这不会影响编译和测试，但隐患就产生了，错误的注释还不如没有注释。
合适的变量名、方法名远比注释有用
young7657
2018-09-26 17:28:13 +08:00
把注释当成文档来写也不太好吧
fundebug
2018-09-26 20:11:55 +08:00
@swim2sun 《 clean code 》果然精辟，变量名和方法名确实得花点心思，不能随便取！
zky001
2018-09-27 18:27:25 +08:00
能说清楚就好啦！

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/492441

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX