几句话说清楚代码和注释的关系
- 代码是一种计算机语言写的小说;
- 代码的注释是以人类语言去解释这部小说,这种解释不是翻译,是剧情的架构,或者关键点的说明,有助于读代码的人容易理解。因此注释一般采用白话文,避免需要二次注释;
- 好的代码是流动的思想,好的语言也是;
- 道,可道,非常道。名,可名,非常名。可以说出来(可)的道理,就不是通用性规律性(常)的道理,可以说出来的定义(名),就不是通用性定义。什么意思呢?就是语言是一种表达思想的工具,但是是有缺陷的,是无法完全贴切的表达他要表达的思想。因此,作为代码的注释来说,是更应该相信代码,而不是注释,因为代码是计算机语言,是精确的,无模糊地带的。而注释反而是“非常名”,“非常道”。注释是阅读代码的辅助,而已。