我应该向作曲家提供哪些 Codeigniter 目录以创建技术文档？

Question

我正在使用 PhpDocumentor 为 Codeigniter 项目创建技术文档。

我知道如何为简单的 PHP 项目创建文档，但是为 CodeIgniter 项目创建文档非常困难，因为我不知道应该将供应商文件夹放在哪里以及哪个目录（如应用程序或控制器）我应该提供给作曲家。

我没有找到任何将 PHPDOC 与 CODEIGNITER 集成的解决方案、教程或文章。 因此，我们将非常感谢您提供一些帮助或解决方案的链接。

或者有人可以推荐一个比phpdoc更好并且可以轻松与CodeIgniter集成的工具。会很有帮助的

Answer 1

为了记录应用程序，通常有两种方法，有些人会分别进行。

对于用户/消费者，只有可用的 API 会显示在文档中。这要求您非常具体地确定要包含哪些文件/类。有些人使用@api 标签来标注类和方法，但我不确定哪些文档生成器能够识别该标签。

对于开发人员文档，您应该包含来自您自己的代码的所有内容，但大多数人不包含来自 vendor/ 的依赖项。但是，如果您想要真正全面的文档，以便任何依赖类也在文档中，您将包括 vendor/。在这种情况下，您将该文件夹放在哪里并不重要，只要您告诉文档生成器包含它即可。