3

一般に、PHPDOCのプロパティは自明ですが、私はこれらを理解するのに苦労しています。

@category-これは正確には何ですか？

@package-誰かが私にこのプロパティの使用法についての例を教えてもらえますか？

4

2 に答える 2

10

パッケージタグは、コードで使用する主要な整理タグです。phpDocumentorはドキュメントを生成するときに、設定したパッケージに要素を収集します。場合によっては、コードベース全体に1つのパッケージ名（@package MyPackage）のみを使用して、すべてのファイル、クラスなどがそのパッケージのドキュメントに表示されるようにすることができます。

ただし、物事をよりモジュール化して整理することを選択した場合は、すべてのWeb向け手続き型ファイルを1つのパッケージ（@package Webpages）に、すべてのデータベース向けクラスをパッケージ（@package DatabaseHandlers）に、すべてのユーティリティクラスをパッケージ（@package DatabaseHandlers）に含めることができます。 @package Utilites）、およびそれ以降。

@packageについて覚えておくべき重要なことは、それがドキュメントを整理するための手段であるということです...それはコードの実行方法とは何の関係もありません。さて、明らかに、頭の中でアプリの一部を概念的に整理する方法に基づいてドキュメントを整理したいと思う可能性が高いので、この意味で、「パッケージ」はコードを整理しているように感じます... しかし最後に、パッケージタグは、phpDocumentorでドキュメントを整理する方法に関するものです。

カテゴリタグに関しては、PEARプロジェクトに関係するものを除いて、出力コンバータがそれを利用しているとは思いません。カテゴリは、パッケージのセットを1つの大きなバンドルに収集するために使用されます。しかし、繰り返しになりますが、これは、どの機能がすでに出力コンバーターに組み込まれている限り、PEARにのみ関連します。必要に応じて、このタグを無視できます... phpDocumentorがドキュメントを整理する方法の中核であるため、パッケージタグを無視することはできません。

さて、@ packageの使用例については、すでに述べたように、マニュアルにいくつかあります。簡単に言うと、すべてのファイルのファイルレベルのdocblock（グローバルスコープの関数と定数が「パッケージ」を取得する場所）とすべてのクラスのdocblockにパッケージタグが必要です。これらのコード要素のパッケージ値を指定しない場合、phpDocumentorはそれらすべてを「デフォルト」パッケージにダンプすることを余儀なくされます。

最後のポイント...コードをさまざまなパッケージに整理する必要がなく、すべてのファイルを編集して@packageタグを追加したくない場合は、代わりに-dnruntime引数を使用してデフォルトのパッケージを設定できます。名前[1]。これにより、phpDocumentorは、パッケージ名が必要なすべての「パッケージ化されていない」コード要素に対して、その引数で指定したパッケージ名を使用するように指示されます。デフォルトのカテゴリ名を設定するための-dc引数もありますが、phpDocumentorに関する限り、これはそれほど重要ではありません。

[1] -http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.defaultpackagename

（私はより多くのURLを含めていましたが、stackoverflowでは複数のURLを投稿できません...）

于 2009-11-21T14:18:01.727 に答える
4

@カテゴリー

@categoryタグは、パッケージのグループをまとめて整理するために使用されます。

これは、XML：DocBook / peerdoc2コンバーターに直接適用でき、他のコンバーターで使用できます。phpDocumentorにパッケージされている他のコンバーターはカテゴリーを無視しますが、これは将来のバージョンで変更される可能性があります。-dc、-defaultcategorynameコマンドラインスイッチを使用してカテゴリを動的に指定することもできます。

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.category.pkg.html

@パッケージ

@packageは、手続き型ページまたはクラスを文書化するためにのみ使用できます。

パッケージは、関連する要素を論理的にグループ化するために使用されます。関連する関数とデータをグループ化するクラスを作成すると、phpDocumentorはファイルのコンテンツ（関数、定義、およびインクルード）を「手続き型ページ」として表します。パッケージは、ディレクトリが関連ファイルをグループ化するのと同じ方法で、クラスと手続き型ページをグループ化するために使用されます。

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html

于 2009-11-21T13:22:49.573 に答える