私が文書化しているコードベース内のすべてのファイルは、常に同じバージョンの「文字列」を使用します。指定されているかどうかに関係なく、PhpDocumentorがすべてのファイルに同じバージョンを使用するように1か所で指定できる方法はありますか（自動継承する必要があります）
...そして、これは頭のてっぺんから外れるのに役立つ他のタグは何ですか？
編集：
親子関係を回避できるものはありますか？バージョン、作成者、著作権を読み取るための.iniまたは構成ファイルのようなものですか？
1 に答える
1
PHPDocumentorがこのようなことを許可していることを私は知りません。
また、すべてのファイルで同じバージョンを使用することは、私には間違った使用法のように思われます。バージョン注釈は、特定のファイルのバージョンを示します。クラスAのバグを修正する場合、クラスBのバージョンが変更されるのはなぜですか。
複数のドキュメントに同じ注釈を挿入する場合は、IDEのテンプレート機能を調べることをお勧めします。通常、このようなスニペットを構成して、キーボードショートカットを使用するか、新しいファイルを作成するときに挿入できます。
もう1つのオプションは、PhingやAntなどのデプロイスクリプトまたはコードリポジトリのpre-commitフックを使用してドキュメントを作成するときに、アノテーション値を設定および置換することです。
編集phpdocumentorのマニュアルをもう一度読んで、私はこれを見つけました：
{@inheritdoc}インラインタグは、子クラスのクラス、メソッド、およびクラス変数のDocBlockで使用されます。phpDocumentorは、親クラスから@ authorタグ、@ versionタグ、および@copyrightタグを自動的に継承します。さらに、ドキュメントコメントが存在しない場合は、親のドキュメントを継承します。
{@inheritdoc}インラインタグが存在せず、子クラスがドキュメント化されていない場合でも、子クラスは親クラスからドキュメントをそのまま継承しようとすることに注意してください。{@inheritdoc}を使用すると、親クラスのドキュメントを子クラスのドキュメントのどこに配置するかを柔軟に設定できます。
それはあなたが探しているものとは正確には異なりますが、同じような方向です。
于 2010-02-26T21:22:45.630 に答える