ホームページ > 記事 > バックエンド開発 > PHP プログラムの標準コメントの仕様ガイドライン

PHP プログラムの標準コメントの仕様ガイドライン

不言オリジナル: 2018-07-19 15:13:567613ブラウズ

phpは比較的とっつきやすい言語なので多くの人が気軽に始められますが、学習の過程ではPHPの標準コメント仕様も遵守する必要があります。

私たちはよく関数を書きますが、その関数は自分にしか理解できないもので、しばらくすると何を書いたのかさえ分からなくなることがあります。もちろん、コードにコメントを追加するのが最善の方法です。

私たちはコメントや PHP コメントなどを書く多くの方法に精通しているかもしれませんが、私たちが使用する主な方法は # と /**/。

# は短いコメントメソッドです。おそらく、これを使用して変数に注釈を付けたり、メソッドを呼び出したりすることになるでしょう。 /**/ です。コメントに今でも使用することがあります。コードの大部分を取り出しますが、それを使用して関数に標準的に注釈を付けるにはどうすればよいでしょうか?

/**
* @name Name
* @abstract 変数/クラス/メソッドの宣言
* @access この変数、クラス、関数/メソッドのアクセス権を指定します
* @author 名前と電子メールアドレス関数作成者のアドレス

* @category 組織パッケージ
* @copyright 著作権情報を指定します
* @const 定数を指定します
* @deprecate 非推奨または廃止された情報を指定します
* @example 例
* @exclude は、現在のコメントが分析されず、ドキュメントに表示されないことを示します。
* @final は、これが最終クラス、メソッド、または属性であり、派生と変更が禁止されていることを示します。
* @global は、この関数で参照されるグローバル変数を指定します。
* @include は、インクルードされたファイルの情報を指定します。
* @link はオンライン接続を定義します。
* @module は、属性付きモジュール情報を定義します
* @modulegroup 所属モジュールグループを定義します
* @package 所属パッケージ情報を定義します
* @param 関数またはメソッドのパラメータ情報を定義します
* @return 関数またはメソッドの戻り情報を定義します
* @see は、参照する必要がある関数と変数を定義し、対応するハイパーリンクを追加します。
* @since は、API 関数またはメソッドがどのバージョンから導入されたかを示します。
* @static は、変数、クラス、関数が静的であることを示します。
* @throws この関数がスローする可能性のあるエラー例外と、それらが発生する状況を示します。
* @todo 改善すべき領域、または実装しない領域を示します。
* @var 変数/属性を定義します。
* @version バージョン情報を定義します
*/

コメント内の情報は非常に包括的です。使用していない情報もたくさんあるかもしれません。赤い部分はよく使用するものです。。

例:

ファイルヘッダーテンプレート

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author      richard<e421083458@163.com> 
* @version     $Id$ 
* @since        1.0 
*/

関数ヘッダーコメント

/** 
* some_func  
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @return array 
*/  
public function thisIsFunction($string, $integer, $mixed) {return array();}

クラスコメント

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author         richard<e421083458@163.com> 
* @since          1.0 
*/  
class Test   
{  
}

プログラムコードコメント

1. コメントの原則は、問題を明確に説明することであり、多ければ多いほどよいということではありません。

2. いくつかのステートメントは論理コードブロックとして使用され、このブロックのコメントは /* */ モードで使用できます。

3. 特定のステートメントに固有のコメントには、行末コメント // を使用できます。

/* 生成配置文件、数据文件。*/  
  
$this->setConfig();  
$this->createConfigFile();  //创建配置文件  
$this->clearCache();         // 清除缓存文件  
$this->createDataFiles();   // 生成数据文件  
$this->prepareProxys();  
$this->restart();

PHP プログラムの標準コメントの仕様ガイドライン

関連記事