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

Question

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

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

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

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

Answer 1

要记录应用程序，通常有两种方法，有些人则分别做这两种方法。

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

对于开发人员文档，您将包括自己代码中的所有内容，但大多数人并不包括来自vendor/的依赖项。但是，如果您需要真正全面的文档，以便文档中也包含任何依赖项类，则应包括vendor/。在这种情况下，只要您确实告诉文档生成器包括该文件夹，那么该文件夹的位置就无关紧要。