PHPDocを用いてクラスのAPI documentを自動で作成する

PHPDocとはPHPのプログラムにおいてクラスやメソッドの前にコメント形式でパラメータや返り値、留意点などを記述することでそれらに関する API documentを自動生成することのできるツール。
Composerさえインストールすれば簡単に導入ができるので、プロジェクト全体の構造を把握したい場合に効果を発揮する。
各関数やクラスの定義前に以下のようなコメントブロックを追加することでdocumentに反映される。  

  /**
   * 関数の概要をここに書く
   *
   * もう少し詳しい説明はここに書く
   * 複数段のコメントも可能。
   * 
   * @param int $id
   * @param string $name
   * @return array $info idとnameを含んだ配列
   * @link 参考資料のURL
   * @see 紐づけたい関数など
   * @throws 可能性のある例外を記述する
   * @todo TODO事項
   */
  public function exec($id, $name){
    $info = array();
    // ...
    return $info;
  }

AWS構築サービスの全てをまとめた資料を公開中

ハックノート(TOWN株式会社)では、AWSの導入や構築支援を行っています。AWS導入メニューやサービス詳細、構成例や費用を掲載した資料をダウンロードできます。

AWSの新規導入やAWSへの移行を検討の際は、ぜひご参考ください。


APNコンサルティングパートナー

TOWN株式会社はAmazon公認コンサルティングパートナーです。