ホームページ > バックエンド開発 > PHPチュートリアル > PHPの命名とコメントの仕様

PHPの命名とコメントの仕様

WBOY
リリース: 2016-06-13 12:20:46
オリジナル
825 人が閲覧しました

PHP の命名とコメントの仕様

1. コメント

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

/** *这是一个什么文件 * *此文件程序用来做什么的(详细说明,可选。)。 * @author      richard<[email&#160;protected]> * @version     $Id$ * @since        1.0 */  
ログイン後にコピー

2. 関数ヘッダーのコメント

/** * 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();}  
ログイン後にコピー

3. クラスのコメント

/** * 类的介绍 * * 类的详细介绍(可选。)。 * @author         richard<[email&#160;protected]> * @since          1.0 */  class Test   {  }  
ログイン後にコピー

4. プログラムコードのコメント

1) を説明します。明らかに問題は、多ければ多いほど良いというわけではありません。

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

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

/* 生成配置文件、数据文件。*/    $this->setConfig();  $this->createConfigFile();  //创建配置文件  $this->clearCache();         // 清除缓存文件  $this->createDataFiles();   // 生成数据文件  $this->prepareProxys();  $this->restart();  
ログイン後にコピー

2. 命名規則

http://alloyteam.github.io/code-guide/#project-naming

関連ラベル:
ソース:php.cn
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート