领悟

编写高效文档的技术- -

                                      

编写高效文档的技术

 

l         注释应能增加代码清晰度

质量，而不是数量，才是我们追求的目标。

l         在写代码之前写文档

这在编写代码之前给了你思考的机会，思考代码如何工作，并且能确保文档一定会写出来。

l         注释做这些事情的理由以及正在完成的事情

基本上，你总能看懂一段代码弄清楚它是干什么的。为什么这样做呢，如果没有注释，根本不可能弄清楚。

好的代码的注释行数经常会比“真正的”代码行数要多。

 

《面向对象软件开发教程（原书第2版）》（The Object Primer 2^rd Edition The Application Developer’s Guide to Object Orientation and the UML）[加] Scott W. Ambler 著 车皓阳 刘锐 译 机械工业版

- 作者： stonexu 2004年10月19日, 星期二 16:43