[PHP]phpDocumentor

phpDocumentor是一個產生PHP library 文件的工具(註解要按照PHPDoc格式來撰寫)

Pear 安裝

pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor

composer 安裝(composer.json)

{
    "require-dev": {
        "phpdocumentor/phpdocumentor": "2.*"
    }
}

指令及參數查詢

phpdoc --help

產生文件

# -f file 代表要產生的輸入檔案
# -d directory 代表要產生的輸入目錄
# -t target 產生出來文件的目的路徑
# --template 可以選擇輸出使用的template
phpdoc -f <file_name> -t <path>
phpdoc -d <dir_name> -t <path>
phpdoc -d <dir_name> -t <path> --template="clean"

基本語法(可參考 文件)
範例

<?php
/**
  * @package Vendor\Metadata
  */
namespace Vendor\Metadata;

/**
  * Album meta class
  * @example example.php How to use this class
  */
class Album
{
    /**
      * @var integer album_id
      */
    private $album_id;

    /**
      * Construct function
      * @param integer $album_id
      * @return void
      */
    public function __construct($album_id = 0)
    {
        $this->album_id = $album_id;
    }
}