phpのコードコメント：@returnタグ

Question

PHPの次の関数の `@returnタグのために、PEAR標準に従ってコードコメントを書く方法を知りたいと思います。

PEAR standardsを通過、私はことを学んだものの：リターンタグは、その後 データの記述をデータ型が含まれている必要があり

1. が返さ：（この部分はかなり明確である）
   

2. 説明：説明の最初の名詞は、パラメータのデータ型です。 "a"、 "an"、 "the"のような記事は、名詞の前に付けることができます。 説明はフレーズで始まる必要があります。 さらに詳しい説明が必要な場合は、文章を続けてください。

私の質問は：どのように私は機能が正常に実行される場合はtrueを返し、次の機能のための@returnタグの説明を書くのですか？あなたが指定するリンク先のページとして

function AUTOCODER_writeFile($filename, $code) 
{ 
    $handle = fopen($_POST['db']."/".$filename, "w"); 
    fwrite($handle, $code); 
    fclose($handle); 
    return true; 
} 

Answer 1

、のdocblockはがphpDocumentorを使ってPEARのドキュメントを生成するために使用されているコメント。

あなたの機能のための最小限のdocblockコメントは次のようになります。それは文字列でなければ

/** 
* @param string $filename 
* @param string $code 
* @return bool 
*/ 
function AUTOCODER_writeFile($filename, $code) 
{ 
    $handle = fopen($_POST['db']."/".$filename, "w"); 
    fwrite($handle, $code); 
    fclose($handle); 
    return true; 
} 

が$codeの正しいタイプでstringを交換してください。コードがこのように動作する場合は、文字列または数値（intまたはfloat）のみにすることができます。

有用なdocblockに名前の後に各引数の目的を記述させ、その関数が何をするかを記述する行を挿入します。あなたはphpDocumentor's documentationにあなたのコードを文書化する方法についての詳細な情報を見つけることができます

/** 
* Store a code into a file 
* 
* @param string $filename the name of the file 
* @param string $code  the value to store 
* @return bool 
*/ 

：ような何か。それはPHPドキュメントの事実上の標準です。多くのIDEがそれを理解しており、コードを実行することなくヒントやエラーの検出に役立ちます。