Delphi内のリソースファイル PHPファイルのコメントマークと仕様概要

PHP コメントタグ
@access
使用範囲: class、function、var、define、module
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected
@author
作成者を示します
@copyright
使用範囲: クラス、関数、変数、定義、モジュール、使用
著作権情報を示します
@非推奨
使用範囲: クラス、関数、変数、定義、モジュール、コンテンツ、グローバル、インクルード
未使用または廃止されたキーワードを示します
@example
マーカーは、ファイル コンテンツのセクションを解析し、強調表示するために使用されます。 Phpdoc は、このタグで指定されたファイル パスからファイルの内容を読み取ろうとします
@const
スコープの使用:define
php
@final で定義された定数の指定に使用されます
スコープの使用:class、function、var
キーワードが最終的なクラス、メソッド、および属性は派生または変更することが禁止されています。
@filesource
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@global
この関数で参照されるグローバル変数を示します
@ingore
ドキュメント内の指定されたキーワードを無視するために使用されます
@license
HTML タグの に相当し、最初に URL が表示され、次に表示されますコンテンツ
たとえば、Baiduは、@license http://www.baidu.com Baidu
@link
と同様に記述できます。ライセンスを取得するには
ただし、リンク
@name を通じてドキュメント内のキーワードを指定することもできます
キーワードのエイリアスを指定します。
@package
使用範囲: ページ レベル -> 定義、関数、インクルード
クラス レベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループ化するために使用されます。
@abstrcut
現在のクラスが抽象クラスであることを示します
@param
関数のパラメータを指定します
@return
メソッドまたは関数のリターンポインタを指定します
@static
キーワードが静的であることを指定します
@var
変数の型を示します
@version
バージョン情報を示します
@todo
改善すべき領域または実装されていない領域を示します
@throws
この関数がスローする可能性のあるエラー例外と極端な状況を示します
共通ドキュメントのマークアップ 各行の先頭に @ を付ける必要があります。また、{@} で表されるインライン タグと呼ばれるタグもあり、次の種類があります。
{@link}
使い方は同じです。 @link
{@source}
関数またはメソッドの内容を表示する
コメントの仕様
a. コメントは、
/**
* 注釈コンテンツ
*/ の形式である必要があります
b. グローバル変数を参照する関数の場合、glboal タグを使用する必要があります。
c. 変数の場合、その型は var (int、string、bool...) でマークされる必要があります。
d. 関数は、param および return マーカーを介してパラメータを指定する必要があります。 または 2 回出現するキーワードの場合。他の関数やクラスが呼び出される場合は、ドキュメントを読みやすくするために、link または他のタグを使用して対応する部分にリンクする必要があります。
g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメントを使用します。
h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。
i. グローバル変数、静的変数、定数は対応するタグで記述する必要があります。
以上、Delphi のリソース ファイルの概要、PHP ファイルのコメント マークと仕様について、Delphi のリソース ファイルの内容を含めて紹介しました。PHP チュートリアルに興味のある友人の参考になれば幸いです。