PHPDocで関数の詳細をいつでも参照可能にする
/**
* 引数の値にいくつかの値を足した値を取得する関数
*
* @param int $base_val 元の値
* @param int #add_val 足し合わせる値
*
* @return int 足し合わせた値
* @see https://exampel.com/
*
*/
function add($base_val, $add_val = 1) {
$total = base_val + add_val;
return $total;
}
上記はPHPの記法で、fucntion add()の詳細についてPHPDocという記法を用いて記載してあるコードです。
以下の部分が、PHPDoc記法に基づいた詳細記載です。
/**
* 引数の値にいくつかの値を足した値を取得する関数
*
* @param int $base_val 元の値
* @param int #add_val 足し合わせる値
*
* @return int 足し合わせた値
* @see https://exampel.com/
*
*/
こうすることで、関数名addにカーソルを合わせて, (Macの場合)
cmd + k + i
で、add関数の詳細情報を開いて見ることができます。
備忘録として。
また、初学者の方の参考にもなれば幸いです。
Author And Source
この問題について(PHPDocで関数の詳細をいつでも参照可能にする), 我々は、より多くの情報をここで見つけました https://qiita.com/uebahide/items/1512a2e4d71c9d8c6e90著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .