Doxygenコメント例(PHP)

プログラムのメモ

  • 個人的には良いコードはそれだけで理解できるものだと思っているが、そんな会心なコードをかけるわけでもない。
  • 自分ひとりで書いてても忘れていることもあるので、可能であればメモは残しておいたほうが良い。

Doxygen

  • Javadocは業務で使ったことはあるが、その他の言語でも使えるとなるとDoxygenかなと。
  • インストールは特に難しくなかった(Windows 10)。

事例

  • 覚えることは大してないが、少しだけ事例を残しておく。
<?php
/**
 * @brief 足し算結果を返す
 * @details 詳細について記載
 * @param a 第一項
 * @param b 第二項
 * @return 足し算結果
 */
function add($a,$b) {
    return $a + $b;
}
$x = 1;
$y = 2;
echo add($x,$y);
/**
 * @brief Doxygen用クラス
 */
class Sample {

    /**
     * @fn minus($a,$b)
     * @param a 第一項
     * @param b 第二項
     * @return 引き算結果
     */
    function minus($a,$b) {
        return $a - $b;
    }
}