phpdox documentation generator for PHP projects

composer安裝

composer require --dev theseer/phpdox 

設定檔

.\vendor\bin\phpdox --skel > phpdox.xml.dist

phpdox.xml.dist 設定

<project name="phpdox" source="${basedir}/src" workdir="${basedir}/build/phpdox/xml">
...
<generator output="${basedir}/docs">

source 是要分析的目錄
output 文件產生的地方

畫面

然後就會列出目錄底下相關的namespaces, classes等等

Classes

在classes的部分會顯示有哪些methods還有這些methods的描述等等

結論

主要是幫助自己在開發的時候, 不要相同的邏輯又寫一次

參考

phpdox github