讨论&投票.关于代码里的注释
今天和公司里的人争论了代码里注释的问题,同事有抱怨说我代码注释过少.
我个人则是"少写注释并编写能够自我说明的代码"风格的绝对支持者.即类似
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等等。

注释应该提供那些不能一下子从代码中看到的东西，或者把那些散布在许多代码里的信息收集到一起。当某些难以捉摸的事情出现时，注释可以帮助澄清情况。如果操作本身非常明了，重复谈论它们就是画蛇添足了。

给函数和全局数据加注释。注释当然可以有价值。对于函数、全局变量、常数定义、结构和类的域等，以及任何其他加上简短说明就能够帮助理解的内容，我们都应该为之提供注释。
全局变量常被分散使用在整个程序中的各个地方，写一个注释可以帮人记住它的意义，也可以作为参考。

放在每个函数前面的注释可以成为帮人读懂程序的台阶。如果函数代码不太长，在这里写一行注释就足够了。

有些代码原本非常复杂，可能是因为算法本身很复杂，或者是因为数据结构非常复杂。在这些情况下，用一段注释指明有关文献对读者也很有帮助。此外，说明做出某种决定的理由也很有价值。

应该注释所有不寻常的或者可能迷惑人的内容。但是如果注释的长度超过了代码本身，可能就说明这个代码应该修改了。

不要与代码矛盾。许多注释在写的时候与代码是一致的。但是后来由于修正错误，程序改变了，可是注释常常还保持着原来的样子，从而导致注释与代码的脱节。

学生常被告之应该注释所有的内容。职业程序员也常被要求注释他们的所有代码。但是，应该看到，盲目遵守这些规则的结果却可能是丢掉了注释的真谛。注释是一种工具，它的作用就是帮助读者理解程序中的某些部分，而这些部分的意义不容易通过代码本身直接看到。我们应该尽可能地把代码写得容易理解。在这方面你做得越好，需要写的注释就越少。好的代码需要的注释远远少于差的代码。



------解决方案--------------------

探讨

觉得《程序设计实践》作者：（美）柯奈汉（Kernighan,B.W.） 著
这本书上关于注释的观点挺好的


引自：http://book.csdn.net/bookfiles/549/10054918395.shtml
注释是帮助程序读者的一种手段。但是，如果在注释中只说明代码本身已经讲明的事情，或者与代码矛盾，或是以精心编排的形式干扰读者，那么它们就是帮了倒忙。最好的注释是简洁地点明……

------解决方案--------------------
1
------解决方案--------------------
如果可以把代码写成诗一样 能够直接读下来 何必要注释 不过 知音又有多少 就不好说了 我是尽量不看注释的 就象设计模式一样 看到符号 就知道 他是干什么的 怎么实现的 知道怎么去用 不过你要是写文章 就要有标题 让我知道 你写的是关于什么的
------解决方案--------------------
先投一票咯再說 ··
------解决方案--------------------