110,535
社区成员
发帖
与我相关
我的任务
分享讨论&投票.关于代码里的注释
今天和公司里的人争论了代码里注释的问题,同事有抱怨说我代码注释过少.
我个人则是"少写注释并编写能够自我说明的代码"风格的绝对支持者.即类似
string CreateSession(string key, SessionItem value);
这种一眼就能看出是干啥的非公开成员函数我一概不写注释(就我个人来说,
我对.net的xml注释风格十分的讨厌,因为它看着感觉很丑.但为了能方便的生
成文档在一些public函数处也不得不写).如果名字有二义性的则在旁边加上
简单的注解.函数内简单的逻辑或调用之类的也不写;因为我觉得这些地方过
多的注释反而影响代码阅读时的思维的连贯性.当然复杂的地方我的注释还是
写得不少的(比如某IL代码生成函数我基本是一行代码一行注释).
那么,就你个人来说,你阅读代码时更喜欢哪一种注释呢?
[iframe=http://vote.csdn.net/VotePostSimple.aspx?voteid=8653][/iframe]
我个人则是"少写注释并编写能够自我说明的代码"风格的绝对支持者.即类似
string CreateSession(string key, SessionItem value);
这种一眼就能看出是干啥的非公开成员函数我一概不写注释(就我个人来说,
我对.net的xml注释风格十分的讨厌,因为它看着感觉很丑.但为了能方便的生
成文档在一些public函数处也不得不写).如果名字有二义性的则在旁边加上
简单的注解.函数内简单的逻辑或调用之类的也不写;因为我觉得这些地方过
多的注释反而影响代码阅读时的思维的连贯性.当然复杂的地方我的注释还是
写得不少的(比如某IL代码生成函数我基本是一行代码一行注释).
那么,就你个人来说,你阅读代码时更喜欢哪一种注释呢?
[iframe=http://vote.csdn.net/VotePostSimple.aspx?voteid=8653][/iframe]
...全文
请发表友善的回复…
发表回复
zheng_www 2011-09-12
- 打赏
- 举报
注释必须要写的，在代码维护的时候，注释的作用就能显现出来了，即使是自己看，日后也方便对自己曾经的思想进行改进！
maycxd 2010-06-10
- 打赏
- 举报
能简洁当然简洁,为什么要一步步都注释说明,个人认为看着也不美观
cnremix 2010-06-01
- 打赏
- 举报
我也不太喜欢写注释..
o123o567o 2010-05-25
- 打赏
- 举报
投票、接分
wgc 2010-05-25
- 打赏
- 举报
注释太多，感觉也很丑。
傻_吖_头 2010-05-25
- 打赏
- 举报
呵呵 本人喜欢 第一个。。。
WilliamTau 2010-05-25
- 打赏
- 举报
一般会选择写详细一点的注释
Eitiable 2010-05-25
- 打赏
- 举报
肯定是2撒~~ 这个是起码的规范LZ
qldsrx 2010-05-25
- 打赏
- 举报
话说这里还能发投票帖啊，就没有看到过这样的功能。
jvchuan 2010-05-25
- 打赏
- 举报
2、 所有函数皆有注释,函数体内有流程的说明.
66.5% (475票)
66.5% (475票)
hualoveqi 2010-05-25
- 打赏
- 举报
多写注释比较好吧
Emt__Only 2010-05-24
- 打赏
- 举报
代码不是写给你自己一个人看的，别人比你傻就看不懂，别人看不懂就拖进度，所以，还是尽量写些吧，呵呵呵呵，我喜欢C#注释
bypeng 2010-05-24
- 打赏
- 举报
先投一票
yuchixl 2010-05-24
- 打赏
- 举报
详细的注释,以便他人阅读方便
professional2010 2010-05-24
- 打赏
- 举报
投完票来接分
飛雪傳奇 2010-05-24
- 打赏
- 举报
注释要有的。不然时间长了，自己都忘记写的是什么了
zhanlang9075 2010-05-21
- 打赏
- 举报
个人习惯用第一个，但是没办法只能用第二个。（仅此而已）
cecilia2006 2010-05-21
- 打赏
- 举报
唉 我个人蛮支持楼主观点的 只要是主要的关键的地方写详细点 其他的不写也罢 不过公司有相应的规范 注释写的头疼
奔腾286 2010-05-21
- 打赏
- 举报
每个方法加个注释，仅为规范。要是实在没有什么好注释的就这样写：//方法名//。
gyj20061111 2010-05-21
- 打赏
- 举报
好记性不如乱笔头~~第二个~
加载更多回复（302）
