php - PHPDocでコントローラーのアクションを文書化する良い方法はありますか？

Question

私は、phpmvcフレームワークでコントローラーのアクションを文書化するための良い方法を見つけようとしています。アクションのURLをそこに固定する方法があることは私にとって非常に重要です。私の問題は、それをphpdocのスキーマに適合させる方法が見つからないように見えることです。

score 4 · Accepted Answer

私はあなたの問題/質問を本当に理解していません。コントローラアクションに関連するURLを含め、必要なものをphpdocブロックに入れることができます（必要に応じてマークアップを使用することもできます）。

/**
 * This is some foo action.
 *
 * URL: /foo/bar/baz
 */
public function fooAction(/* ... */) {
    // ...
}

とはいえ、などのカスタムタグを具体的に使用する場合は、コマンドラインオプションを使用して、カスタムタグに遭遇したときに解析エラーをスローしないようにphpdocに指示する@url必要があります。：-ct

# Will specify custom tag @url
phpdoc -ct url ...

score 0 · Accepted Answer

解決策は、ドキュメントの生成に使用するソフトウェアによって異なります。

私も同様の問題を抱えていて、 doxygenに切り替えました。Doxygenを使用すると、@ action_urlなどのカスタム情報をドキュメントコメントに追加したり、HTML、PDF、マニュアルページなどを生成および出力したりできます。

2 に答える 2