プログラムにコメント書かない文化もあるよって話｜NZ MoyaSystem

以下の記事を読んで。 530000micro.hatenablog.com 僕が勤めている会社では、原則、プログラムにコメントを書かないのがルールです。 人生で初めてプログラムに触れてからこのかた、プログラムには必ずコメントを書けと指導されて来ましたし、自分自身も、後輩たちにちゃんとコメント書けよと言い聞かせてきました。そんなわけで、最初に全然コメントのないソースコードの山を見たときは、正直「ゲッ、なんじゃこりゃ……」と面食らったのは確かです。 ところが、「なぜうちのプログラムにはコメントがないのか？」と同僚に尋ねてみると、実に納得の行く回答が返ってきたのでした。 なぜコメントが必要なプログラムを書くのか？ 同僚いわく、「コメントが無くても読めるようなプログラムを書け」という思想が根底にあるのだそう。 適切に関数や変数が命名され、スコープがきちんと管理され、ロジックの流れが整理されているコ

[sds-page]

コメント書かなくていいコードって「健全な肉体には健全な精神が宿る」的な理想論で人類はその域に達してないのでおとなしくコメント書くべき

[kabochatori]

昔先輩には「実況をするな解説をしろ」と教えられました。

[NOV1975]

そもそも「処理の内容」はコメント文化であってもコメントすべきではない。たまに「変数aに引数xの値を代入する」とか書いてあってクラクラする。そうじゃなくてコメントに書くべきなのはその処理になっている理由

[ka-ka_xyz]

多分この話は、（コードとして記述できない）コンテキストに絡む話はコミットログなりチケットなりにがっつり書くことが暗黙の前提に思えるけど、その辺の説明がすっぽり抜けてる気が。

[ShoCoh]

こういう文化圏があるのは知ってるが、コメントなしで理解できるように書くのは前提で、それでもコードだけでは伝えられない情報があるからコメントを書くんだよ。詳しくはリーダブルコード参照

[masayoshinym]

コメント書かない話なのにリーダブルコードの広告が表示されてる不思議。

[practicalscheme]

この仕様を実現するのに通常はAやBという手法を使うが今回のケースに限っては何某が何年に出したこの方法の方が性能が出たのでそれを使った。詳しくはこの論文参照、っていうようなメタ情報はどこに書くの?

[lets_skeptic]

// Microsoftがどうしても直さないバグ対応で必要 参照 → http://(フォーラムURL) というコメントがいくつかある。

[adwd118]

// その場しのぎの処理。仕方がない。 　の是非に対する回答にはなってないのでは？

[raitu]

いくら可読性の高いコード書いても、コメント無しにビジネス上の意図を明示できるわけないんだからおとなしくコメント書くべき。そのへんは「リーダブルコード」にもあったよ

[kakei-akihiko]

書くとか書かないとかの2値で考えない。コードが読みやすくなるほどコメントは邪魔になる。あと「仕様がどうなってるから」というのはコメントじゃなくてコードで表すべき。

[vanbraam]

方法論としては理解できるし各論はおおよそ同意するが,原理主義は苦手;コードに関する情報はコードに近い所に,が原則だと思うので,JavaDocの様なdocumentation commentsは許されるべき派

[no_2615]

いちいちバージョン管理するのが面倒な、使い捨てだけどもしかしたら次も使うときあるかもしれないみたいなコードに少しは解説ほしいときとかコメント便利なような

[aquos12345]

ルーザーの国ですから

[blackblue1]

うちでは、スピードアップの為にテストケースが削減されている。

[Chiastolite]

何をしてるかはコメントなくてもわかるようにして、何故そうしたか(仕様だったり、冗長な書き方してる理由だったり)はコメントorコミットログに残せば良さそう

[nntsugu]

[programming][work]そういや今関わっているチームもこんな感じかも。コードじゃなくてPRにコメントがあるね。

[mas-higa]

"ただのプレーンテキストなので" プレーンテキストでも意味が伝わる自然言語能力を

[tettekete37564]

“「コメントが無くても読めるようなプログラムを書け」”<ダウト。高級言語ならコードは読めて当たり前。問題はどんな目的を達成する為になんでその処理を行っているかがわからないとエンバグや改修・保守時に地獄

[nilab]

プログラムにコメント書かない文化もあるよって話 - NZ MoyaSystem

[minifigures]

そもそも「処理の内容」はコメント文化であってもコメントすべきではない。

[j5ik2o]

Docコメントに限っていえば仕様を記述する意味があると思う。例えばそれがバグかどうかは実装コードをみても仕様が明示されないと基本的には判断不能。詳しくはメイヤー本の契約による設計を参照してほしい。

[hiroomi]

”品質を守るための強固な仕組みがあってこそ、コメントを書かないという文化が実現可能なのだと”

[pero_0104]

私もリーダブルコード読んだからコメントなるべく書かない考え方好きだし実行してるー！この辺はもはや宗教だから、批判や揚げ足これの説明は〜みたいなコメも仕方ないよねー

[ewiad420]

技術レベルは人によって違うけど、誰に合わせて書くんだろう？

[sawarabi0130]

それは極論だが、修正前のコードはコメントアウトで残さずリポジトリで管理するのがそろそろ常識になってほしい今日この頃。

[PowerEdge]

変数やら関数やらのネーミングに気を付けるだけでコメントはグッと減るよな　この点、日本語は損してる

[BT_BOMBER]

文化というかメンバーの実力が全員十分なら通用する話。実際には開発規模が大きくなるとレベルが落ちる人も入れざるを得ない場合が出てくるはず。少数精鋭で一定以下の開発規模でないと難しいと思う

[rzi]

なんだ、「プログラムにコメント書かない」って話か。コメントはコメントで分けましょう、ってことですね。それならわかる。けど自分の記憶力に自信がないことには自信があるのでプログラムにも書きたい。

[sugibuchi]

本質的にはコードが自分以外の誰に読まれるかの問題でコメントはその一部。均一なスキルセットを持った現場と様々なレベルのメンバーが関わる現場では当然解は異なる。

[ite]

コードがどんなに良くても、それは基本的にHowを書くためのもの。Whyを書けるのはコメントで、それは設計やデザインに近い。プログラムにコメント書かない文化があるのは結構だが、私はそこに関わりたくない

[rti7743]

動くけどコメントが一切ないソースコードといえば、逆汗したアセンブラだが、コメント内からソースを読みまくってwhy?を探るためにとても苦労する。なぜそう書くのかはコメントを入れてほしいなあと。

[valinst]

自分も「コメントを書かなくていいようなコードを書くべきだけど、それは無理だから必要に応じてコメントを書こう」派。

[northlight]

視点が個人レベルなんだよなあ

[tockri]

abstractとかtraitとか、抽象度がいろいろ変わりながらたくさん書くときに最初に考えてたこと忘れちゃうので、メソッドの中身を作る前にコメントに「○○のために○○する」って書いてる。コメント駆動開発。

[sasupen]

コメントなしで理解できるコードを作る教育もよろしく

[yuuAn]

以前はコメントを書かない文化の会社で働いてたけど、それでよかったのはコードの品質を高く維持できていたからで、それは優秀なコードレビューアがいてくれたからなのだと一人で働いてみて解った。

[moondoldo]

コードに現れない情報があって、それが後々見る人の理解に必要だと思われる時に書くのがコメントであって、コードで表せるならそもそもそこにコメント書かないよ

[quick_past]

なぜこうしてるのか、はそのメソッド内かせめてクラス内で閉じてるならまだしも、外のクラスやフレームワークなどの仕様変更で振る舞い変わっちゃうとコメントだけ修正しわすれが発生したりするのがめんどい。

[koogawa]

「コメントが無くても読めるようなプログラムを書け」という思想が根底にあるのだそうだ。いや、でも書いて欲しい