我应该向作曲家提供哪些代码点火器目录来创建技术文档?



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

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

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

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

对于记录应用程序,通常有两种方法,有些人会分别使用这两种方法。

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

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

最新更新