PHPコードで@sinceコメントを使用しています。ただし、その使用法について質問があります。特定のタスクを実行する関数があり、バージョン1.0で実装されているとします。
だから私は現在@since1.0を持っています。
次に、関数の名前を変更しますが、内部のコードは同じままです。@since 3.0（現在のバージョン）と表示する必要がありますか、それとも@since 1.0のままにする必要がありますか？
質問する
3580 次
3 に答える
22
関数名は1.0には存在しなかったため、@since3.0にする必要があります。別の名前の関数が古いバージョンで同じ機能を提供していたことは関係ありません。古いバージョンでは新しい名前を使用できません。ドキュメントによると：
@since「この関数はバージョン2.0以降、このパッケージの一部になっています」のように、リビジョンを文書化するために使用します
の目的は@since、パッケージを使用している人に「バージョンx以降、という名前の関数がfoo存在することを伝えることです。v3に変更fooしてv1のbarまま@sinceにすると、ドキュメントにはv1で安全に呼び出すことができると誤って記載されますbar()。実際には、 bar()v1にはありませんでした。呼び出しは、エラーをスローします。
また、古い名前（実際の関数を呼び出すだけ）の関数スタブを保持し、それをマークすることを検討することもできます@deprecated。
于 2013-03-05T16:43:50.263 に答える
3
@since タグは、関連する構造要素が使用可能になったバージョンを示します。
構文
@since [version] [<description>]
@since タグを使用して、どのバージョン固有の構造要素が使用可能になったかを示すことができます。
この情報を使用して、特定の要素に必要なアプリケーション バージョンを消費者に通知する一連の API ドキュメントを生成できます。
バージョンは、@version タグのベクトルと同じ規則に従わなければならず (MUST)、追加情報を提供する説明を含めることができます (MAY)。
このタグは、PHPDoc 内で複数回使用できます。その場合、各発生は変更ログへのエントリとして扱われます。また、そのような各タグに説明を提供することをお勧めします。
例
/**
* @since 1.0.1 First time this was introduced.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}
/**
* @since 1.0.2 Added the $b argument.
* @since 1.0.1 Added the $a argument.
* @since 1.0.0
*
* @return void
*/
function dump($a, $b)
{
<...>
}
于 2013-03-12T16:13:18.490 に答える
0
phpDocタグなので
PHPDoc タグは、一部のエディターと連携して、コードに関する詳細情報を表示します。これらのエディターを使用する開発者にとって、コード内でそのエディターを使用する目的と場所を理解するのに役立ちます。
PHPdoc ブロックを許可するための規則は、@since 情報 (その時点で利用できない場合でも) と @package 情報を含めることです。外部ライブラリでない限り、これらは常に「WordPress」でなければなりません。次のように
/**
* ... Description(s) here
*
* @package WordPress
* @since 2.1 or {@internal Unknown}}
*
* ... More information if needed.
*/
phpDoc タグの詳細については、次の記事をお読みください。
要素が最初にパッケージに追加された時期 (バージョン) を文書化する
于 2013-03-12T12:55:50.197 に答える