cakephpのコメント

Question

     /**
      * View method 
      *
      * @param string|null $id Job id
      * @return \Cake\Network\Response|null
      * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found
      */

controller先頭に書いてあるこのコメントアウトで書かれている文章があると思うんですけど、
これってコメントであってますよね？

VScodeだと色が変わって

「ん？有効なのかな？」

と思ってしまい、不安になってしまいました。

これコメントアウトであってますよね？

Answer 1

コメントです。
色がかわる云々はPHPDocに則って書かれている部分をIDEが拾ってくれているだけと思います。

Comments

[kazumasamatsumo]

ありがとうございます！！

[m.ts10806]

「PHPDoc」きちんと調べておいてください。フレームワークを取り扱うなら知っておいて損はありません

[kazumasamatsumo]

はい！ありがとうございます。

Answer 2

コメントであってます
そのコメントを付けてるメソッドの仕様を記載してますね

Google JavaScript スタイルガイド - 日本語訳
いわば標準的なコメントの書き方なんで、覚えておくといいかと

Comments

[kazumasamatsumo]

ありがとうございます！！
そうですよね。よかった。
助かりました！！

[maisumakun]

元のコードがJavaScriptではなくてPHPだと思われます。

[y_waiwai]

い、いや、JSDocの解説ぐぐって出てきたページがこれだったもんでｗ

[maisumakun]

PHPDoc、ですね

[y_waiwai]

JSDocで覚えてました。
ああ、JSってそーゆーことだったんだ（ｲﾏｻﾗ

Answer 3

クラスやメソッドの先頭にある /** */ で囲まれた複数行のコメントは、ドキュメントブロック(DocBlock)と呼ばれています。
これは通常のコメントとは取り扱いが違い、プログラムの一部とみなされます。

ドキュメントブロックには@で始まるアノテーションを書くことができ、これでパラメーターの型などを指定することができます。

また、CakePHPでは標準では機能がないのですが、他のフレームワークやライブラリによっては、このアノテーションの記述によってプログラムの挙動が変わったりしますので、下手に削除すると動かないといったことがあります。

コメントだけどただのコメントじゃないよということです。