回答編集履歴
1
リンク修正等
answer
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
コメント自体についてはmaisumakunさんの回答の通りです。
|
|
1
|
+
コメント自体についてはmaisumakunさんのご回答の通りです。
|
|
2
|
-
これの何が嬉しいかというと、phpDocumentorというツールを使って 、クラスドキュメントの自動生成ができることです。
|
|
3
|
-
サンプルは下記のようなものになりますが、例えばご質問の@propertyをきちんとコメントに書いておくと、メソッドの引数説明のところに想定している値は何であるかを出力してくれます。
|
|
4
2
|
|
|
5
|
-
|
|
3
|
+
これの何が嬉しいかというと、[phpDocumentor](https://www.phpdoc.org/)というツールを使って 、クラスドキュメントの自動生成ができることです。
|
|
4
|
+
サンプルは下記のようなものになりますが、例えばご質問の`@property`をきちんとメソッドのコメントに書いておくと、メソッドの引数説明のところにコメントに記載した内容（想定している値は何であるか等）を出力してくれます。
|
|
6
5
|
|
|
6
|
+
[http://demo.phpdoc.org/Clean/classes/phpDocumentor.Application.html](http://demo.phpdoc.org/Clean/classes/phpDocumentor.Application.html)
|
|
7
|
+
|
|
7
8
|
このような仕組みはjavadocなど他の言語にもあるもので、PHPでも用意されているということになります。
|