倡议-帖上的程序加上清晰明了的注释和好编程风格-支持的顶下

shusl

chinaunix.net  是个大家非常推崇的技术论坛，每天有数以千记的各种水平的爱好者来此布道求经，布道者希望自己的观点和技术精华为大家所接受和推崇，求经者希望能在最短的时间内得到最大的收获。
   也许很多大虾很牛，泱泱千百行代码一目十行，刷刷一会就可以把握十之八九，然后毕竟是菜鸟多，所以我提议每位在此帖程序（不管是多复杂还是很精悍的程序）的布道者或求经者，都能在程序上做好注释，同时有个清晰的编程风格。
    其实，在写程序注释的过程也是一个提高的过程，至少我这么认为！因为天才毕竟是少数，常言道，好记性不如烂笔头！而在现实的工作中，程序的注释也是非常重要的，有些规范的软件开发商，对程序员的要求最起码的一条：程序至少有30%以上的注释。因为很多软件开发是一个大的工程，从分析-开发-修改-测试-修改-维护，不可能由一个人完成，都是团队合作的结果。因此程序注释和好的编程风格显的极为重要！
   在此，我倡议，希望每个帖上来的程序都有个好的注释和编程风格，提高自己，方便大家！

flw

不完全赞成。
《编程之道》上说，最好的注释就是程序本身。
注释最好不要超过 5%，否则得不偿失。

shusl

我觉得工程应用中的许多程序最好超过30%，因为你编的程序不只是你自己一个人看的！

flw

我们永远不要走两个极端。

flw

超过 30% 是什么意思？就是说，平均每写两行代码，就要写一行注释。估计这样的程序也只会在教材中出现吧？

shusl

对，极端的人总是没有更多收获的！重要的是希望大家的水平都能提高！
：）

shusl

当然，我说的注释并不是指 #include<iostream.h>;  、{} 、也要注释！注释的目标是使我们三个星期以后看到程序也有个清晰的思路，你说对吗？

qjlemon

我看一些程序里面有的注释比代码长得多很多，但这种情况很少， 一般只是在关键的地方”点”一下。  
我觉得大部分情况下”点”一下就行了，“最好的注释还是代码本身”，这句话没错。

flw

我再强调一遍：[quote]原帖由 "flw"]超过 30% 是什么意思？就是说，平均每写两行代码，就要写一行注释。估计这样的程序也只会在教材中出现吧？[/quote 发表：

flw

一般来说，如果程序员注意一下各种标识符的命名，尽量做到“望文即可生义”，然后再加上适当的空行和空格。那么[quote]原帖由 "qjlemon"]在关键的地方“点”一下[/quote 发表：
就足够了。
一句话，主要还是风格要好。

试设想一下，如果 #include 不需要注释、复制语句不需要注释、标准的函数调用也不需要注释，那么还有多少东西需要我们注释？无非也就是一些“关键的地方”了，这些地方的注释加起来会超过 30% 吗？答案是不会。除非你的注释仅仅是为了把每条语句的语义解释一遍。

另：注释很重要，因为他可以让别人读懂你的程序，但是永远都不要妄想让白痴都读懂你的程序，除非你是计算机教育家，象谭老师就是。换言之，注释到底应该有多少？以能够让另外的同事/同行看懂为标准，不需要让小学生都能看懂。