代码没有注释和文档，程序员没有任何错误

Posted 2023-03-12 柳鲲鹏

　　程序员写的代码，没有注释、没有文档，是不是错误？当然不是。

• 要求别人写注释和文档，就必须有工作计划，安排工作时间。你会安排吗？

当然，你确实安排了时间让别人写注释、文档，如果不写就是错误。

• 别人写了注释和文档，你就要提出要求，随之而来的就是审核、考核等一系列手段来保证。这可能吗？
• 最后，你也确实审核了，而且你能力高超，也确实看懂了发现了问题，表示了不满。作为一个程序员，他并不是故意写这么差，他写注释文档就这水平，你能怎么办？

　　六石编程学明确指出，注释和文档本身没什么用。到目前为止，相信没有任何一个人能站出来说，某某文档、注释对我理解代码产生了明显作用。

　　有用的文档，包括原理、流程、接口说明（实际上接口也没用，你必须提供范例）、操作文档。这些跟我们说的代码相关的注释和文档，并无关系。