好学谷

　　很多程序员工作中非常轻视文档的书写，但又时常抱怨别人不写文档，或者说文档质量不好，不够完善，更别说一些刚学习嵌入式教程的新手了。

　　为什么大家都不愿意写文档，因为文档有着滞后性，不能立刻体现出它的价值。所以很多人更喜欢跑测试，一跑就知道有没有问题了，这样的价值体现就会快许多。而且文档的价值更多的不是在开发者手中体现的，而是在其他人阅读的过程中体现的。

　　其实很多人是会把代码和文档割裂开来，在思想层面上二者就是分开的，所以很多人不会将二者同时进行。其次有些人写文档本来就不怎么好，干脆就不写了，有时候更是懒惰作祟。更别说写文档其实是增加工作负担，自己的工作都没空处理，哪还有空去写文档。

　　即便写文档有这么多坏处，其好处也不少。比如说可以帮你审视你的API，让其更加规范化，这个过程其实就是检验的过程，让你可以从头检查一次自己的代码。而这样的文档一般在你回头看的时候可以快速知道自己写了什么，别人也更清晰地了解你的代码。

　　当别人问你问题的时候，你也可以直接丢文档让他自己看，虽然写文档需要时间，但也减少了解答问题的时间。这样还能让别人觉得你的代码非常专业，毕竟同样的时间，质量下，你做了更多的东西。

　　所以，建议大家在学习嵌入式教程的时候就要养成好习惯。早期养成良好习惯就不用担心工作的时候没有时间去重新掌握，而且当你熟悉了书写步骤其实会进一步提高你的工作效率。

　　本文原创 文章来源：好学谷 转载请标明出处：http://www.haoxuegu.com/