讨论&投票.关于代码里的注释今天和公司里的人争论了代码里注释的问题,同事有抱怨说我代码注释过少.我个人
讨论&投票.关于代码里的注释
今天和公司里的人争论了代码里注释的问题,同事有抱怨说我代码注释过少.
我个人则是"少写注释并编写能够自我说明的代码"风格的绝对支持者.即类似
string CreateSession(string key, SessionItem value);
这种一眼就能看出是干啥的非公开成员函数我一概不写注释(就我个人来说,
我对.net的xml注释风格十分的讨厌,因为它看着感觉很丑.但为了能方便的生
成文档在一些public函数处也不得不写).如果名字有二义性的则在旁边加上
简单的注解.函数内简单的逻辑或调用之类的也不写;因为我觉得这些地方过
多的注释反而影响代码阅读时的思维的连贯性.当然复杂的地方我的注释还是
写得不少的(比如某IL代码生成函数我基本是一行代码一行注释).
那么,就你个人来说,你阅读代码时更喜欢哪一种注释呢?
[iframe=http://vote.csdn.net/VotePostSimple.aspx?voteid=8653][/iframe]
[解决办法]
先投一票~
[解决办法]
所有函数皆有注释,函数体内有流程的说明.
个人喜欢这个。脑子不好使，有些时候自己的想法就忘了。还是记下来好些。
[解决办法]
我来啦,我是自己觉得可能比较生疏,或者实现过程比较难的,我才会重点写注释了.
呵呵.
不过如果是单独出的类里面的方法,要经常用到的,我就会加说明.
[解决办法]
所有函数皆有注释,函数体内有流程的说明.
一切推荐用这一个，尤其是团队开发时。不过我还是喜欢第一个 呵
[解决办法]
[解决办法]一般来说。重点的，不太懂的。花的时间很长的。会注解说明。。
[解决办法]自说明的有是在你看来是这个意思，说不一定别人一看，以为是另外一个意思
[解决办法]public 方法的注释还是要写的，给其他地方调用的时候，可以通过智能提示显示说明。.net frameworks类库的类和方法的命名应当能一眼就看出大概干嘛的吧，但是为什么还需要提供那么多注释的内容呢，因为不是库的设计者，不可能了解调用该方法的一些细节，比如参数的作用，是否可以为null，方法调用可能产生那些异常，不知道这些的话，怎么放心调用你提供的方法呢
[解决办法]觉得《程序设计实践》作者：（美）柯奈汉（Kernighan,B.W.） 著
这本书上关于注释的观点挺好的
引自：http://book.csdn.net/bookfiles/549/10054918395.shtml
注释是帮助程序读者的一种手段。但是，如果在注释中只说明代码本身已经讲明的事情，或者与代码矛盾，或是以精心编排的形式干扰读者，那么它们就是帮了倒忙。最好的注释是简洁地点明程序的突出特征，或是提供一种概观，帮助别人理解程序。
不要大谈明显的东西。注释不要去说明明白白的事，比如i++能够将i值加1等等。
注释应该提供那些不能一下子从代码中看到的东西，或者把那些散布在许多代码里的信息收集到一起。当某些难以捉摸的事情出现时，注释可以帮助澄清情况。如果操作本身非常明了，重复谈论它们就是画蛇添足了。
给函数和全局数据加注释。注释当然可以有价值。对于函数、全局变量、常数定义、结构和类的域等，以及任何其他加上简短说明就能够帮助理解的内容，我们都应该为之提供注释。
全局变量常被分散使用在整个程序中的各个地方，写一个注释可以帮人记住它的意义，也可以作为参考。
放在每个函数前面的注释可以成为帮人读懂程序的台阶。如果函数代码不太长，在这里写一行注释就足够了。
有些代码原本非常复杂，可能是因为算法本身很复杂，或者是因为数据结构非常复杂。在这些情况下，用一段注释指明有关文献对读者也很有帮助。此外，说明做出某种决定的理由也很有价值。
应该注释所有不寻常的或者可能迷惑人的内容。但是如果注释的长度超过了代码本身，可能就说明这个代码应该修改了。
不要与代码矛盾。许多注释在写的时候与代码是一致的。但是后来由于修正错误，程序改变了，可是注释常常还保持着原来的样子，从而导致注释与代码的脱节。
学生常被告之应该注释所有的内容。职业程序员也常被要求注释他们的所有代码。但是，应该看到，盲目遵守这些规则的结果却可能是丢掉了注释的真谛。注释是一种工具，它的作用就是帮助读者理解程序中的某些部分，而这些部分的意义不容易通过代码本身直接看到。我们应该尽可能地把代码写得容易理解。在这方面你做得越好，需要写的注释就越少。好的代码需要的注释远远少于差的代码。
[解决办法][解决办法]1
[解决办法]如果可以把代码写成诗一样 能够直接读下来 何必要注释 不过 知音又有多少 就不好说了 我是尽量不看注释的 就象设计模式一样 看到符号 就知道 他是干什么的 怎么实现的 知道怎么去用 不过你要是写文章 就要有标题 让我知道 你写的是关于什么的
[解决办法]先投一票咯再說 ··
------解决方案--------------------
跟楼主一样的风格
[解决办法]看公司要求了,要求写注释我就写,不要求就写必要的.
[解决办法]最好的注释是没有注释。
往往使用注释是因为我们的代码可读性不够好，所以需要使用注释说明。
切不可为了注释而注释。
[解决办法]可以投4个咦
[解决办法]票是要投的，，分是要接的。。
[解决办法]我经常会遇到自己写的代码都不知道是在干什么的，特别是在系统维护的时候，但是有点注释就感觉方便多了，
所以你的代码如果给别人看的，那么请你尽量详尽，
如果给自己的看的，至少要当自己在长时间之后再回来看都能看出来他时干什么的就行。
[解决办法]个人开发的程序最好 注释能少则少.
在公司编写代码最好 所有函数皆有注释,函数体内有流程的说明.
我在想：你的这种统计是如何转到C# 版中来的呢？。。。
[解决办法]我投1~
[解决办法]做好文档编写工作如接口的输入输出，参数说明
实现的功能
[解决办法]投的2 自己偏是1
[解决办法]每个方法都按照标准的格式进行注释 : 方法的内容, 输出参数说明,返回值说明
变量的申明也可以简单的注释, 说明变量是用于存储的内容
[解决办法]xuexi
[解决办法]我们在学作业的时候
老师就让我多注释说明
这样别人再调你的方法时知道是什么意思！~
也方便以后的维护！~
[解决办法]在看别人代码的时候，如果注释得详细，对于代码的搜索有很大的帮助，中国人对中文的反应速度要远远高于其他文字。。。这点还是不可否认的
[解决办法]1、 自说明的代码,注释能少则少.
[解决办法]支持楼主！！
[解决办法]谢谢谢谢分享，呵呵……曾经想过
[解决办法]我写的时候会将那些逻辑性比较强的地方加上注释，习惯了，呵呵～
[解决办法]楼主，你肯定是哪个人的马甲，论坛这么高级方法都会用啊。居然能发出投票。！
[解决办法]因为是希望看到的，当然选2了
[解决办法]程序是最好的注释
[解决办法]选择2吧，注释非常重要
代码能不能自说明，代码作者自己是判断不出来的，以后维护这段代码人才能判断出来
往往越大公司约重视注释
因为在大公司里开发代码和维护代码的一般都不会是同一个人
[解决办法]能让人看懂就行了
[解决办法]自代码不如xml理解业务方便
[解决办法]不太懂啊
[解决办法]自己个人写,如果方法和参数名长到能说明清楚,就不需要注释
团队作战,即使再清楚,也要写明,复杂过程,每行标注
[解决办法]你可以用中文,这样可以不用注释
[解决办法]我一般阅读代码都是从代码直接入手，不看注释的，因为注释有可能不准确的，比如我就不习惯写注释的，但是规范应该遵守的啊
[解决办法]支持搂住，我周围的同事也是这样，大小都得用注释说明，有时候注释比代码都多，唉
[解决办法]
所有函数皆有注释,函数体内有流程的说明.
肯定选这个，主要是怕时间久了忘了当时的想法了。
[解决办法]
觉得《程序设计实践》作者：（美）柯奈汉（Kernighan,B.W.） 著
这本书上关于注释的观点挺好的
引自：http://book.csdn.net/bookfiles/549/10054918395.shtml
注释是帮助程序读者的一种手段。但是，如果在注释中只说明代码本身已经讲明的事情，或者与代码矛盾，或是以精心编排的形式干扰读者，那么它们就是帮了倒忙。最好的注释是简洁地点明程序的突出特征，或是提供一种概观，帮助别人理解程序。
不要大谈明显的东西。注释不要去说明明白白的事，比如i++能够将i值加1等等。
注释应该提供那些不能一下子从代码中看到的东西，或者把那些散布在许多代码里的信息收集到一起。当某些难以捉摸的事情出现时，注释可以帮助澄清情况。如果操作本身非常明了，重复谈论它们就是画蛇添足了。
给函数和全局数据加注释。注释当然可以有价值。对于函数、全局变量、常数定义、结构和类的域等，以及任何其他加上简短说明就能够帮助理解的内容，我们都应该为之提供注释。
全局变量常被分散使用在整个程序中的各个地方，写一个注释可以帮人记住它的意义，也可以作为参考。
放在每个函数前面的注释可以成为帮人读懂程序的台阶。如果函数代码不太长，在这里写一行注释就足够了。
有些代码原本非常复杂，可能是因为算法本身很复杂，或者是因为数据结构非常复杂。在这些情况下，用一段注释指明有关文献对读者也很有帮助。此外，说明做出某种决定的理由也很有价值。
应该注释所有不寻常的或者可能迷惑人的内容。但是如果注释的长度超过了代码本身，可能就说明这个代码应该修改了。
不要与代码矛盾。许多注释在写的时候与代码是一致的。但是后来由于修正错误，程序改变了，可是注释常常还保持着原来的样子，从而导致注释与代码的脱节。
学生常被告之应该注释所有的内容。职业程序员也常被要求注释他们的所有代码。但是，应该看到，盲目遵守这些规则的结果却可能是丢掉了注释的真谛。注释是一种工具，它的作用就是帮助读者理解程序中的某些部分，而这些部分的意义不容易通过代码本身直接看到。我们应该尽可能地把代码写得容易理解。在这方面你做得越好，需要写的注释就越少。好的代码需要的注释远远少于差的代码。
投票,帮顶,支持楼主!
[解决办法]
2,我个偏向1.
可能由于我做的项目小的原因吧
但我有修改过别人代码的经历 想哭呀 有注释是一件常见的事情,有时候是写给自己看的
因为经验越多处理功能...越加合理 所以有时候以前设计的东西 自己看不懂了
添加注释 不是每个人都和你一样
[解决办法]
所有函数皆有注释,函数体内有流程的说明.
[解决办法]
函数名，变量名，属性名都很清晰。丫还跟我提注释？public的都不写注释的飘过。
[解决办法]
个人认为。。注释有助于别人阅读你的程序
[解决办法]
看公司要求了,要求写注释我就写,不要求就写必要的
[解决办法]
注释，一些一眼就能看懂的函数。我就不注释了。复杂一点的，还是需要的。以后自己看，也不会摸不着头脑。
[解决办法]
我认为还是第2条，多写一点。时间一长，自己都需要时间回忆当时的思路。。
[解决办法]
要是自己做，注释加不加都无所谓，加注释改BUG的时候可以更快
[解决办法]
同意楼主的
[解决办法]
有时自己写的都不知道是做什么的了！
[解决办法]
个人感觉注释是要写,方便阅读!
[解决办法]
我希望每个函数都有注释，有些复杂的函数，分支多了的，还是有注释的好，不然别人要看你的流程，修改问题那真是一种煎熬
[解决办法]
顶起来。。。。。
[解决办法]
顶顶顶
[解决办法]
string CreateSession(string key, SessionItem value);
对啊,我一看也知道是创建会话的函数,有2个参数,key和value,返回一个string,
我只能看出这么多了,再想知道多的就要看代码了,
比如,key参数是任何字符都可以吗?还是一定要32位?只能是数字和字母吗?可以包含#$%%这些吗?
还是应该使用提供的另外一个方法来生成key,比如,CreateKey?
返回的string是新的session id吗? 只包含数字和字母吗?如果是,那么我不需要进行URL编码,否则,那我就要进行URL编码了
所以...我还是要看代码了..
如果是你一个人使用,那真不用注释了,不过,过几个月之后说不定你自己也还要看代码..
[解决办法]
没有注释的代码不是好代码..但是太繁琐也不行
[解决办法]
顶...................
[解决办法]
meitianjiefen yishicunzai
[解决办法]
注释还是有必要的，
[解决办法]
我英语烂， 如果所有方法、属性名都使用中文的话，我赞成不写注释。
但英语的话，看着废劲，还是写写中文注释比较好
[解决办法]
多写点吧~现在维护别人的东西那个F12啊....累死
[解决办法]
飘过~~~~~~~~
[解决办法]
~~~~~~~
[解决办法]
先投一票
[解决办法]
路过~~
[解决办法]
注释是一定要写的，但是本人觉得要精简。
[解决办法]
注释一定要写，尤其是团队开发！
[解决办法]
没注释很快就忘记了
[解决办法]
前3个我都选了,呵呵
[解决办法]
没必要弄得到处是注释
[解决办法]
选1了。。。
[解决办法]
团队一起开发的，还是要考虑一下群体
[解决办法]
如果是自己一个人开发，那么就注释一些可能混淆的地方
但是团队开发就应该尽量详细，节省开发时间
[解决办法]
希望是用自己语言表述的注释
[解决办法]
其实没有更好的选项，我只能选择“自说明的代码,注释能少则少. ”
正常情况下，我更倾向于“代码的注释，以阅读者能够清晰明了代码编写者的意图为衡量标准，恰到好处即可”，需要注意自己感觉别人一定会懂的，不要注释这种情况，需要以团队人员的情况作为参照标准，如果团队配合很默契，有些地方则不要过多注释，但是如果团队成员之间水平差异较大，而你的代码阅读者恰恰属于这种情况，则必须要考虑多一点注释了。
总之以“代码能够更好地被团队成员阅读，以便使用”为标准，个人觉得比较恰当。
[解决办法]
[解决办法]注释少
[解决办法]自说明的代码,注释能少则少.
呵呵，注释是必要的说明，也就是有必要才说，没必要则不必说。
另外上面有些人选择吧 想法，过程，思路，甚至是抱怨通通写在注释里，我到觉着过了。注释是注释，不是编程日记，也不是流水账
[解决办法]已投
[解决办法]TOU PIAO
[解决办法]注释很重要，
这样方便自己以后看的时候快一些，
也方便别人看
http://s.click.taobao.com/t_1?i=rEvPXgwwYO%2FhFA%3D%3D&p=mm_16390215_0_0&n=11
[解决办法]代码还是规范为上. 使用.NET的XML注释给阅读者和以后维护带来方便.
[解决办法]先来投票
[解决办法]我是赚分来的
[解决办法]------解决方案--------------------
注释是用来维护的，复杂的算法需要注释。
专业术语用中文，如何不是给外国人瞧的，用英文没有任何意义，何况非专业人员翻译成的英语常常很可笑。时间长了，自己都不知是啥含义．
[解决办法]投一票
[解决办法][解决办法]复杂...............................
[解决办法]好好好好好好好好好好
[解决办法]个人喜欢第一个，但是没办法只能用第二个
[解决办法]
