PHPパラメータのコメント

はじめに: これはphpパラメータコメントの詳細ページであり、phpに関連する知識、スキル、経験、および一部のphpソースコードを紹介します。

class='pingjiaF' Frameborder='0' src='http://biancheng.dnbcw.info/pingjia.php?id=340853'scroll='no'>

すべてのドキュメントのコメントは /* *& で構成されます#&*/
function Add($a, $b) {
return $a+$b;
}

生成されるドキュメントは次のとおりです:
Add
integer Add(int $a, int $b)
[line 45 ]
関数 add は 2 つの数値の加算を実装します

定数 単純な加算計算。この関数は 2 つの数値 a、b を受け取り、その合計を返します。 c

Parameters
? int $a - addend
?
5．ドキュメントタグ:
ドキュメントタグの使用範囲は、タグを使用して変更できるキーワードまたはその他のドキュメントタグを指します。
すべてのドキュメントタグは、各行の * の後の @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。
@access
使用範囲: class、function、var、define、module
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected
@author
作成者を示します
@copyright

使用範囲: class、関数、var、defi

使用範囲:define
php
@finalでdefineの定数を指定するために使用します
使用範囲:クラス、関数、var
キーワードがfinalクラス、メソッド、属性であり、派生、変更が禁止されていることを示します。
@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}
関数やメソッドの内容を表示
6．一部のコメント仕様
a. コメントは
/**
* XXXXXXX
*/
の形式でなければなりません
b. グローバル変数を参照する関数の場合は、glboal タグを使用する必要があります。
c. 変数の場合、その型 (int、string、bool...) は var
d でマークする必要があります。関数は、2 回出現する変数の場合は、パラメータと戻り値のマーカー
e を使用する必要があります。他の関数またはクラスが呼び出される場合、ドキュメントを読みやすくするために、リンクまたは他のタグを使用して対応する部分にリンクする必要があります。
g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメントを使用します。
h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。
i. グローバル変数、静的変数、定数は対応するタグで記述する必要があります
7. 概要
phpDocumentor は、標準化されたコメントを記述し、理解しやすいドキュメントを生成するのに役立ちます。コードのアップグレード、メンテナンス、引き継ぎなどに非常に役立ちます。
phpDocumentor の詳細な手順については、公式 Web サイト
http://manual.phpdoc.org/
8 で確認できます。付録
付録1:
phpdocで認識できるキーワード:
Include
Require
include_once
require_once
define
function
global
class
付録2
ドキュメント内で使用できるタグ

<コード>

<?php/*** Sample File 2, phpDocumentor Quickstart** This file demonstrates the rich information that can be included in* in-code documentation through DocBlocks and tags.* @author Greg Beaver <cellog@php.net>* @version 1.0* @package sample*/// sample file #1/*** Dummy include value, to demonstrate the parsing power of phpDocumentor*/include_once 'sample3.php';/*** Special global variable declaration DocBlock* @global integer $GLOBALS['_myvar']* @name $_myvar*/$GLOBALS['_myvar'] = 6;/*** Constants*//*** first constant*/define('testing', 6);/*** second constant*/define('anotherconstant', strlen('hello'));/*** A sample function docblock* @global string document the fact that this function uses $_myvar* @staticvar integer $staticvar this is actually what is returned* @param string $param1 name to declare* @param string $param2 value of the name* @return integer*/function firstFunc($param1, $param2 = 'optional') {/*** A sample private variable, this can be hidden with the --parseprivate* option* @accessprivate* @var integer|string*/var $firstvar = 6;/*** @link http://www.example.com Example link* @see myclass()* @uses testing, anotherconstant* @var array*/var $secondvar =array(    'stuff' =>                 array(                                   6,                                   17,                                   'armadillo'                           ),     testing => anotherconstant);/*** Constructor sets up {@link $firstvar}*/function myclass() {$this->firstvar = 7;}/*** Return a thingie based on $paramie* @param boolean $paramie* @return integer|babyclass*/function parentfunc($paramie) {if ($paramie) {return 6;} else {return new babyclass;}}}/*** @package sample1*/class babyclass extends myclass {/*** The answer to Life, the Universe and Everything* @var integer*/var $secondvar = 42;/*** Configuration values* @var array*/var $thirdvar;/*** Calls parent constructor, then increments {@link $firstvar}*/function babyclass() {parent::myclass();$this->firstvar++;}/*** This always returns a myclass* @param ignored $paramie* @return myclass*/function parentfunc($paramie) {return new myclass;}}?>

J2EE をフォロー Java Michael Jackson Video Station JSON オンライン ツール
http://biancheng.dnbcw.info/php/340853.html pageNo:6