関数についているコメントについて

他の人のコードを見ていると関数に以下のようなコメントが書かれています。
みんな同じような形で書かれているので決まった呼び方や何か書き方のルールみたいなものがあるのでしょうか？

どんな関数か、
引数の型、
返り値の型を明記することで他の人にわかりやすくなるのはなんとなくわかるのですが、そのほかにも恩恵はありますか？
よろしくおねがいします。

PHP
1    /**
2     * GETパラメータを取得
3     *
4     * @param string $name
5     * @param mixed $default 指定したキーが存在しない場合のデフォルト値
6     * @return mixed
7     */
8    public function getGet($name, $default = null)
9    {
10        if (isset($_GET[$name])) {
11            return $_GET[$name];
12        }
13
14        return $default;
15    }

行動規範の内容に同意します

回答3件

phpDocumentor で調べてみると良いと思います。

投稿2018/12/28 05:21

ssasaki

総合スコア1167

bws

2018/12/28 05:55

早く聞けばよかったです。ありがとうございます！

行動規範の内容に同意します

ドキュメンテーションコメント(Docコメント)と呼ばれるものです。

もろもろリンク先見れば解決するかと。

投稿2018/12/28 05:30

momon-ga

総合スコア4820

bws

2018/12/28 05:56

リンクありがとうございます。読ませていただきます！

行動規範の内容に同意します

ベストアンサー

参考記事
phpDocumentorの書き方
 2018年のPHPDoc事情とPSR-5

EclipseなどIDEでは関数の前に/**と打ってEnter押すだけで雛形を呼び出してくれますね。

php
1    /**
2    protected function test(array $test):bool{
3        
4        
5        return true;
6    }
7

↓

php
1    /**
2     * 
3     * @param array $test
4     * @return bool
5     */
6    protected function test(array $test):bool{
7        
8        
9        return true;
10    }