由注释引发的思考

最近为了改良公司项目的编译系统，正在利用业余时间全力突击perl语言。（该编译系统由20~30个perl脚本来控制整个编译流程。）我发现perl简练、强大，以至于一句代码如果不写二三十行注释的话，打死也猜不出是什么意思。（可怜我们项目那些perl代码中注释不是特别多）于是才引发了关于注释的思考。
一个好注释能帮助其他人理解该段代码的意图，为什么不写清楚呢？虽然写代码的时候多花费了一些时间，但是今后维护起来可就省事的多的多了。可怜很多boss看不穿这些，他们认为只要有高手在就没有搞不定的代码，所以为了赶进度而不狠抓代码规范和代码质量。不过，高手确实能看懂没有注释的代码，但是这并不等于高手理解这些代码不需要时间的。高手至多是能把别人看不懂的没有注释的代码看懂，或者比别人看这些代码略微少用些时间而已。
总结一下就是，他们总认为这条理论是永远成立的：高手总能理解低的手代码，而反之则很难！
为此，我也对自己提两点要求：
一、要写详尽的注释。（基于上述理论，万一我一不小心成为绝世高手，我的代码也不会失传^_^）
二、成为绝世高手。（基于上述理论，只要我能一不小心成为绝世高手，别人不写注释也忽悠不住我了^_^）

嘿嘿，不早了，上班去了。～～




--------------------next---------------------
注释这个问题，很难说吧。
一个简单的函数，他可能会定义参数限制、参数意义、返回值意义等。
而在特定情况下，比如参数限制，可能是很明确，再者在代码里，写程序的一眼就能看出来。
但是，这些写起详细的注释，有时甚至要超越代码本身的时间好几倍，因为要明确的表达。
同样，对这些一看便知的代码，如果写上好几十行的注释，这时，本来简洁的头文件复杂了，本来精悍的原代码冗沓了，这样使得代码反而不易阅读。而且，往往为了避免确保注释有错或不明确（你想知道的信息，注释里没有），有时常常是直接看代码反而更来得确切。
要避免注释有错，可能还真的不可能：你无法保证写代码的人他能够完全掌握它所写的那些代码相关的内容。或者他只是写出来了，运行起来好。而他确实无法预期在哪些糟糕情况，会是什么样；它会带来哪些好处；哪些不利等。而运行起来好是一个普遍的程序界现象。
所以，简洁的代码提示，有时比注释本身来的更好。
因此，个人，觉得注释应该简练提要。
说明这个class是干什么的，会做到什么样；说明这个函数是做什么的，参数意义，参数限制（如果有），返回值意义；这个成员是用了做什么的；这个函数所采用的算法思想简介（如果算法相对比较复杂，而且只有必要写作实现里，如果很简单的算法，没有注释，反而更好）。
但，不论怎样，注释应该提纲挈领，用最简洁的话表达清重要的信息。
--------------------next---------------------