pythonみたいに、PHPもソース中にドキュメントを書きたい!
tk.phpautodoc を使えば出来そう。
pipでインストールできる。
1 2 3 4 |
$ $ pip install tk.phpautodoc $ |
そして、Sphinx の conf.py に次の設定を書き足す。
1 2 |
extensions += ['sphinxcontrib.phpdomain', 'sphinxcontrib_phpautodoc'] |
reSTファイルで
1 2 3 4 5 |
.. phpautomodule:: :filename: source.php :members: :undoc-members: |
関数直前のコメントに簡単に説明を書ける。
phdoc程便利ではないにしても、無いと有るでは全然違う。
作者に感謝。