PHP書いてて本当に要らないなって思うコメント達 - Qiita

俺の場合、ソースコードから語りかけにくるよね。 By ローランド泉 はじめに PHPに限った話ではないですが、コメントってそうそういらないと思うんです。 コメントがいるのはあくまで「コードでは伝わりきらない部分を伝えるため」だと思うんです。 なので、全くいらないわけじゃないし、こういう話をすると永遠に答え出ないと思うんです。 でも、なんでこんなコメント頑張って付けてるのかなって思う事が多々あるので、それを個人的にまとめてみました。 ※今回はPHPだけに絞って考えてみました。 ※今まで自分も漠然と付けてきた部分もあるので、自分への戒めのための記事でもあ－－－るのです。なんて日だ！！ PHPの標準コーディング規約 色々ありますが、「PSR」などを読んでおけばよいかと。 ⇒フレームワークが何を採用しているかは重要なので、あなたが使用しているフレームワークが何基準なのかは押さえておきましょう。 コ

[suika3417]

コメントをしっかり書いとけばIDEが読んでくれて自動補完してくれるから僕は書くよ

[JULY]

そのコメントは、人間がコードを読むときのものじゃなく、ドキュメント生成ツール用なんだけどなぁ。

[jun_ya]

ほんとうに要らないコメントは実装と説明が一致してないコメント。渡されたソースを保守するときにどっちを信じればいいのかわからんのよ。つらい。なうですよ、なう。

[el-condor]

型を明示しない言語だからこそ型を書く意味があるんだけどなあ。まあこのコメントの書き方が良いとは思わないけれどそれはコメントが不十分なのであって全く不要というようには見えないな。PHP詳しくないが。

[rgfx]

「PHPDocumentorとかいらんやろ」大きく振りかぶったなあ

[wordi]

Language Server Protocolの登場でこの辺の事情は急速に変化してて、PHPDocが無くてもType HintingだけあればSignature Helpで型が分かるし、Linterも機能する、Howは変わらず必要

[dozo]

彼と仕事したらコメント記述のプルリク合戦しそう

[thekoruku]

「コメントいる思想を持ってしまうとコメントに頼ってしまって綺麗にコードを書こうと意識しません。」この論理展開が全然わからない。

[n314]

コメントをコードに移して中途半端な「@param」や「@return」を付けるぐらいなら、何もない方がいいかな〜。

[uzulla]

（IDE等が読み書きするフォーマットを）不要だから書かないのは自由と思うんだけど、例みたいにわざわざ@param残して、次に型でない「説明文」を書くと、(PHPDocの)構文エラーになっちゃうから消したほうがいいかな〜。

[AKIMOTO]

歴史的経緯ってやつだな

[s083027]

docからHTMLとかを生成しない身としては、引数・戻り値型宣言を補ってLSPを満足させるためだけのものになってて、気持ちはわかる（チームの規約とか他のと揃える目的で全部書くけど） / PSR-5ってまだドラフトか

[sheepsace]

意見が合わなすぎてブクマ

[naka-06_18]

ネタ、なんだろう。と思う。

[fut573]

全部読める規模じゃなくなってから泣くパターン。

[takhasegawa]

Docコメント書いてると、VSCodeでも呼び出し側でツールチップ形式でコメント表示してくれたりコード補完してくれたりするから便利だよね

[posmaru1]

他の人と未来の自分への思いやりだと考えてなぜそうなったのか適切なコメントを書く能力と、ツール使いこなせてないから自動生成コメントを見分けられないのは別の話なはずなんだけどなぁ…

[programmablekinoko]

気の利いたエディタが挟んでくるのをそのままって感じじゃないのこういうの