编写自文档化的代码

文所以载道也。  —— 宋·周敦颐《通书·文辞》 对于我们程序员来说，我们的工作也是写作——几乎每天都要写代码；而且还要载“道”，不仅仅要满足客户的需求，还要让代码具有高度的可读性，这样其他的程序员可以更容易地对代码进行修改和扩展。 按这样的要求，我们需要为代码编写足够的文档，也就是将代码“文档化”。常见的做法有两种，外部文档和注释。 外部文档 外部文档指的是在代码文件之外编写的附加文档，比如在W

>>阅读原文<<