我正在使用PhpDocumentor为Codeigniter项目创建技术文档 .
我知道如何为一个简单的PHP项目创建文档，但是为CodeIgniter项目创建文档非常困难，因为我不知道应该在哪里放置我的供应商文件夹以及我应该提供哪个目录（如应用程序或控制器）对作曲家 .
我没有找到任何解决方案或教程或文章来集成PHPDOC和CODEIGNITER . 因此，我们将非常感谢您提供一些帮助或解决方案的链接 .
或者有人可以推荐一个比phpdoc更好的工具，并且可以轻松地与CodeIgniter集成 . 这将非常有帮助
1 回答
对于记录应用程序，通常有两种方法，有些人分别做两种方法 .
对于用户/消费者，只有可用的API会显示在文档中 . 这要求您非常具体地说明要包含哪些文件/类 . 有些人使用
@api标记来记录类和方法，但我不确定哪个doc生成器识别该标记 .对于开发人员文档，您将包含自己代码中的所有内容，但大多数人不包含
vendor/中的依赖项 . 但是如果你想要真正全面的文档，那么任何依赖类也在文档中，你会包含vendor/. 在这种情况下，您找到该文件夹并不重要，只要您告诉doc生成器包含它 .