![代码文档和用户文档之间的区别](https://linux22.com/image/266500/%E4%BB%A3%E7%A0%81%E6%96%87%E6%A1%A3%E5%92%8C%E7%94%A8%E6%88%B7%E6%96%87%E6%A1%A3%E4%B9%8B%E9%97%B4%E7%9A%84%E5%8C%BA%E5%88%AB.png)
答案1
好吧,尽管 jjdb 击中了要点:
用户文档 = 用户指南,代码文档 = 程序员指南
我尝试说得更诗意一些:
用户指南,顾名思义,它旨在供用户使用,即坐在计算机后面并使用您的代码做任何他需要做的事情的人。
文档代码是程序员遵循的良好实践的一部分,目的是跟踪他正在做的事情,为任何想要接触代码的人留下清晰的信息,并保持他的头脑清醒(特别是在长时间没有与代码交互后回来时)。
基本上,用户文档应该尽可能地具有解释性,因为您不知道阅读它的人对包的理解程度如何(请记住,如果这是第一个版本,很可能没有人见过它),而代码文档应该以演示您的代码正在做什么以及在哪里执行为导向,以便尽可能轻松地进行任何修改。