php @propertyってどのように使うのでしょうか。

phpでの実装時、phpdocに、「@property string $hoge」とかって書くと思うんですが、これはどのように使用するのでしょうか。
__get() や __set() などのマジックメソッドを使ってるクラスに@propertyタグを使うみたいなことが書いてあったんですが、仕事で見たソースにはマジックメソッドがなくて、あまり腑に落ちませんでした。

マジックメソッドじゃなくて、public function getHoge()のようなメソッドならありました。
これでも良いということでしょうか...

また、どのような点が便利なのかイマイチわからないのでご教示いただけると嬉しいです。

何卒よろしくお願いいたします。

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

回答3件

ベストアンサー

例えば、下記の様なソースを書きたかったとします。

PHP
1<?php 
2class hoge{
3    public $id;
4    /**
5     * IDを取得する
6     * @return Integer
7     */
8    public function getId(){
9        return $this->id;
10    }
11    /**
12     * IDを設定する
13     * @param Integer $id
14     */
15    public function setId(Integer $id){
16        $this->id = $id;
17    }
18}
19/**
20 * @property integer $id IDパラメータ
21 * @method integer getId() IDを取得する
22 * @method void setId(Integer $id) IDを設定する
23 */
24class fuga extends hoge{
25    
26}
27
28$fuga = new fuga();
29$fuga->id = 999;
30echo $fuga->getId();

この時に、fugaクラスには@propertyを記載しています。
するとIDE(この場合は、netbeans)では下記の様にヘルプを出してくれます。

ところが、PHPDocを書かなかった場合には下記の様になってしまいます。つまり、どの様なメソッドやプロパティを使えるのかがパッと見て分からなくなってしまうんですね…

こういう時の為に書く、PHPDocなのだと思いますよ。

投稿2017/10/12 02:35

motuo

総合スコア3027

Pccla

2017/10/12 04:17

皆様の回答とてもわかりやすかったんですが、IDEでの具体的使い方までキャプチャ付きで詳細につけていただいてとてもわかりやすかったので、ベストアンサーつけさせていただきます。ありがとうございます！こういうふうに使うんですね。勉強になりました。

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

それは、PHPDocと呼ばれるコメントです。

定型的に付けたコメントを、IDEなどのツールが読み取って、ヒントとして表示してくれたりします。もちろんコメントなので、コード自体の実行に影響はありません。

投稿2017/10/12 01:30

maisumakun

総合スコア145184

Pccla

2017/10/12 04:19

回答ありがとうございました！

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

コメント自体についてはmaisumakunさんのご回答の通りです。

これの何が嬉しいかというと、phpDocumentorというツールを使って、クラスドキュメントの自動生成ができることです。
サンプルは下記のようなものになりますが、例えばご質問の@propertyをきちんとメソッドのコメントに書いておくと、メソッドの引数説明のところにコメントに記載した内容（想定している値は何であるか等）を出力してくれます。

http://demo.phpdoc.org/Clean/classes/phpDocumentor.Application.html

このような仕組みはjavadocなど他の言語にもあるもので、PHPでも用意されているということになります。

投稿2017/10/12 01:51

編集2017/10/12 02:10