如何生成 Magento 的 API 文档/文档？
我安装了 Magento，我想知道如何生成完整的 API 文档，例如 http://docs.magentocommerce 上的文档.com/ 使用 phpdoc 生成。 Magento 中是否包含一个可用于生成文档的 phpdoc 配置文件？
I have Magento installed and I wanted to know how to generate the full API docs, like the ones on http://docs.magentocommerce.com/ that were generated using phpdoc. Is there a configuration file included with Magento for phpdoc that I can use to generate the documentation?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
实际的程序称为 phpDocumentor，您可以在命令行上使用它通过使用
phpdoc -d $MAGENTO_PATH/app/code/core/Mage/ -t docs来记录核心 Magento 代码。不要忘记创建一个名为 docs 的目录，或者您可以将目标目录设置为您想要的任何目录。要记录扩展的 API，您可以使用
phpdoc -d $MAGENTO_PATH/app/code/local/$PACKAGE/$MODULE其中$PACKAGE是包名称，并且$MODULE是模块的名称，$MAGENTO_PATH是 Magento 的安装位置。警告：生成所有 API 文档可能需要一段时间，因为 Magento 是一个相当大的程序。
The actual program is called phpDocumentor and you can use it on the command-line to document the core Magento code by using
phpdoc -d $MAGENTO_PATH/app/code/core/Mage/ -t docs. Don't forget get to create a directory called docs, or you can set the target directory to whatever you want.To document the API of an extension you can use
phpdoc -d $MAGENTO_PATH/app/code/local/$PACKAGE/$MODULEwhere$PACKAGEis the package name, and$MODULEis the name of the module, and$MAGENTO_PATHis where Magento is installed.Warning: it could take a while to generate all the API documentation as Magento is a pretty big program.