PHP Doc（PHPDoc）とは？

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

/**
 * 関数の説明（概要）
 *
 * 詳細な説明（オプション）
 *
 * @param 型 $引数名 説明
 * @return 型 説明
 * @throws 例外クラス 説明（オプション）
 */
function sampleFunction(int $num): string {
    return "Number: " . $num;
}

1
2
3
4
5
6
7
8
9

/**
 * 数値を文字列に変換する関数
 *
 * @param int $num 変換する数値
 * @return string 変換後の文字列
 */
function convertToString(int $num): string {
    return (string)$num;
}

1
2
3
4
5
6
7
8

/**
 * 現在の時刻を取得する関数
 *
 * @return string 現在の時刻（フォーマット: H:i:s）
 */
function getCurrentTime(): string {
    return date("H:i:s");
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

/**
 * 0で割り算をしないようにする関数
 *
 * @param int $a 割られる数
 * @param int $b 割る数（0はエラー）
 * @return float 割り算の結果
 * @throws Exception 割る数が0の場合に発生
 */
function divide(int $a, int $b): float {
    if ($b === 0) {
        throw new Exception("0で割ることはできません。");
    }
    return $a / $b;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

class User {
    /**
     * @var string ユーザーの名前
     */
    private string $name;

    /**
     * コンストラクタ
     *
     * @param string $name ユーザーの名前
     */
    public function __construct(string $name) {
        $this->name = $name;
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

/**
 * @property string $name ユーザー名
 * @property int $age 年齢
 */
class User2 {
    private array $data = [];

    public function __get($name) {
        return $this->data[$name] ?? null;
    }

    public function __set($name, $value) {
        $this->data[$name] = $value;
    }
}

1
2
3
4
5
6
7
8

/**
 * この関数は非推奨です。代わりに newFunction() を使用してください。
 *
 * @deprecated 1.0.0 代わりに newFunction() を使用
 */
function oldFunction() {
    echo "この関数は非推奨です。";
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

/**
 * 文字列を大文字に変換する
 *
 * @see strtolower() 小文字に変換する関数
 *
 * @param string $str 変換する文字列
 * @return string 変換後の文字列
 */
function toUpperCase(string $str): string {
    return strtoupper($str);
}

1
2
3
4

$ tree .
.
└── src
    └── test-doc.php

1

docker run --rm -v $(pwd):/data phpdoc/phpdoc:latest -d src -t docs

1

docker run --rm -v $(pwd)/docs:/usr/share/nginx/html -p 8000:80 nginx