不给代码写文档，让代码文档化

（给伯乐在线加星标，看经典文章）编译：伯乐在线/小米云豆粥这是程序员讨论了很久的一个话题：要不要给代码写文档？值得给代码写文档吗？我曾经觉得这个话题实在是让人难以应付。也认为除去一些特殊的情况（比如编写公用 API），代码文档并不是那么必要。直到有一天，我在一份代码检查报告中发现，缺少文档被作为一项缺点指出来。真是这样的吗？我曾经也给我的代码写文档——至少我尝试了。我曾深信你必须给代码写文档。以后对我自己，或者对其他需要看我的代码的程序员来说，文档都会是一个好的提示。直到我发现大部分代码文档无法反应最近更新，我就开始思考：“如果无法保证文档反应最近更新， 那写文档的意义到底在哪里呢？”这个想法持 ………………………………