什么样的文档能够帮助理解代码

　　绝大多数人接收别人代码，第一句就是问，有什么文档。这听起来也是理所当然。所以不少软件公司强调要写文档。这里其实有几个问题，需要搞清楚：

　　汝需要什么样的文档？估计听了一愣：是啊，吾想要文档，可是什么样的文档好？

　　假设作者写的文档正确（这几乎是不可能的），现在给了汝文档，汝能正确理解作者的意思？这个不好说吧？

　　现在反问一句：别人要接手汝之代码，汝能提供什么样的确实有帮助作用的文档？这样一问，估计所有人都傻眼了：是啊，吾天天要别人文档，现在别人要吾文档，吾……

　　其实，代码是经常变动的，写的人意思表达肯定不到位，读的人更是云里雾里。试图写一个有帮助的技术文档，至少吾没有看到。

 

　　那么，是不是不要文档？当然不是。一个有帮助作用的文档，有一下内容：

　　开发环境的搭建。

　　范例的运行办法。

　　编译注意事项。

　　功能开关说明。

　　关键流程示意图。