如何生成Magento的API文檔/文檔？

Question

我安裝了Magento，我想知道如何生成完整的API文檔，如使用phpdoc生成的http://docs.magentocommerce.com/。是否有一個配置文件包含在Magento for phpdoc中，我可以用它來生成文檔？

Answer 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是一個相當大的程序。