コードを直訳したコメントは必要なのか?「要る派」と「要らない派のまとめ」【 社畜ちゃん台詞メーカー 】

コードを直訳したコメントは必要なのか? というお題を 社畜ちゃん台詞メーカーで画像を作って投下してみたところ、たくさんのご意見をいただいたのでまとめてみました。
92

ふと気になったので、こんなネタを投下してみました

ビタワン🐕脱サラちゃん&社畜ちゃん連載中@単行本⑥巻6/27発売 @vitaone_

こういうコメントは「要る派」と「要らない派」に分かれますよね… 皆さんはどちらですか… #社畜ちゃん台詞メーカー bit.ly/1Erb1e9 pic.twitter.com/Wm6ttSMg1B

2015-06-30 19:07:55
拡大

このお題?に対して
「直訳コメントは居る派」と
「直訳コメントは要らない派」のご意見を
たくさん頂けたのでまとめてみます

(↑は名言じゃなくて明言ですね...)

Dr. パルス @_space_engineer

@vitaone_ 特殊な変数や、あまり使わない変数なら・・・

2015-06-30 19:08:43
月下 満 @tsukishitam

自分英語読めないからないと困る派

2015-06-30 19:08:53
カイウス @Kaiusu0

俺は何事にもコメントを残す派だね

2015-06-30 19:09:17
サイアナ @ccyana_net

そんなコメント要らないだろ。

2015-06-30 19:09:22
💪(´ω`っ )3 @inaba_yukichi

@vitaone_ その時の上司によって変わる・・・ ですかね

2015-06-30 19:09:33
しゅえ @xuedremn

@vitaone_ ソースコード初心者にも見せるとか、ソースコードの内容を一般にも見て欲しいなら付けるべきかな... 慣れてる人同士で必要な気はしない...

2015-06-30 19:09:36
くわっちょ@社畜犬 @kuwaccho0711

いちいち書かないとわからない奴が本当にいる。備えよう

2015-06-30 19:09:39
ハートフル @komahere2

プログラム初心者なのであったほうが嬉しいですね

2015-06-30 19:09:59
あおしロボ @aoshirobo

難しい問題だよね。ぼくは要らない派だけどgrep検索用と言う意味で敢えて付ける事もそこそこ多い>RT

2015-06-30 19:10:03
れるり @Rek7z

配列に変数つっこんでループさせつつちんぽらり〜な変数使ったりして値を入れるとかパッと見で変態みたいな事をしてると書きます

2015-06-30 19:10:16
ytez🥪 @ytez

ついコメントだらけにしてしまうなあ…

2015-06-30 19:10:26
ぽぽやまぽっく@跡地 @ysm111

コメント読んでけばなんとなく流れつかめるって意味ではあったほうがいいかも?→RT

2015-06-30 19:10:30
ドロテアRR SP🍥 @st_dorothea

@vitaone_ 変数名やメソッド名から分かるならいらないかなぁ。aとかbとか何を略してるか分からない名前使う奴は書いてください(・ω・

2015-06-30 19:11:55
(call me #'knjname) @knjname

こういうクソコメントが必要になるシチュエーションって入門書以外無いでしょ。まあ土方は毎度入門書かかされているようなもんだが

2015-06-30 19:12:06
idiotton @idiotton

そもそもコメント自体不要派だからなぁ。コメントは(コメントを除く)コード自体に記述できなかったという、敗戦処理。

2015-06-30 19:12:13
首の釣り人 @ahohand

>RT ものによっては、後々教材的な活用ができるんだけど そもそもそんなもん書く余裕のある仕事量じゃねえ!って人もいそう

2015-06-30 19:12:41
4LDK @4LDK

こういうのは、俺みたいなプログラムじぇんじぇん分からん人からすると凄くありがたい。 あぁここをいじれば変わるんだーっていうのが分かるから…。 ブログのテンプレートとかね。

2015-06-30 19:12:50
やきとり @kurotoribb_

よほどめんどくさくて長いならあってもいいかも

2015-06-30 19:12:53
Norio Maeda🌷 @nmaeda2

@vitaone_ 変数/関数/オブジェクト名から想像しにくい挙動なら。

2015-06-30 19:12:58
rerofumi @rerofumi

疲れているとこういうコメントを書きがちになる

2015-06-30 19:13:16
冬海 古希👑 @fuyumikoki

あれはごちゃごちゃスパゲティ書いて変数が何指してるかすらわからないような奴には必須だと思われる

2015-06-30 19:13:41
残りを読む(110)

コメント

ビタワン🐕脱サラちゃん&社畜ちゃん連載中 @vitaone_ 2015年7月1日
先ほど投稿したプログラムに関するお題?に対してたくさんコメントをいただいたのでTogetterでまとめてみましたー!
0
ビッター @domtrop0083 2015年7月1日
要らないけど、作業している所のコーディング規約に沿ってコメントを入れた結果こうなるならしょうがない派
0
kusano @t_kusano 2015年7月1日
初中級者→要る、ベテラン→要らない、とまあまあキレイに分かれているのが面白い
0
想 詩拓@文芸サークル『文机』 @sou_sitaku 2015年7月1日
変数の意味が分からないと直訳にもならないし、ここでどういう処理をしているかというコメントは後で見る人のために必要だと思う。
3
Localio Projects @LocalioProjects 2015年7月1日
綴りが違うならコメントは要る。てか、ゲシュタルト崩壊するから綴り違いはやめて。
0
アザゼル白鳥 @luger_ 2015年7月1日
これが図面なら、後々自分の知らないところで一部なり全部なり転用されるかもしれない可能性を考えて、書いておくべき、という考え方になる。分かってる方からすれば目障りだが、万全を期するという意味では必要となる。プログラム関係は門外漢なので分からないが、「このコードをいじるのはベテランだけ」と確証できるなら書かなくて良いのでは?
11
大石陽@聖マルク @stmark_309 2015年7月1日
ビジネスロジックのどこでその処理してんの? とか、検索されやすくするには書いておいたほうがいい。自分しか弄らない分にはいらないけど、しかし自分しか弄れないようなコードがあると休みの日にも電話かかってくるからな。
3
未知神明(みちがみ・あきら) @ontheroadx 2015年7月1日
他の人や○十年後の自分がいじる可能性があるなら、コメントある程度必要なんじゃないかな。
5
ビタワン🐕脱サラちゃん&社畜ちゃん連載中 @vitaone_ 2015年7月1日
タイトルの誤字を修正してまとめを更新しました...
0
qyen @9yen 2015年7月1日
コメントはWhatやHowじゃなくてWhyを書け
19
そむにうむ☆めぐるーまー@森山弘樹 「オタクVxR研究会」主宰 @Somnium 2015年7月1日
アルゴリズムを理解するならまずコードを読めです。そもそもコメント量を多くするのは、書いてる時間で業務時間とコードを水増しするという底辺プログラマの悪習です。必要なのは関数の動作概要と引数の意味のみです。
2
アルビレオ@炙りカルビ @albireo_B 2015年7月1日
このコメント欄には「コメント要る」派ばかりですね。要らない派はまとめにもコメント残さないということですね(ドヤ
20
qyen @9yen 2015年7月1日
これ「コメントそのもの」じゃなくて「直訳コメント」の是非の話でしょ。 そんなの必要とか言うプログラマがいること自体マジで信じられない。 ( 除く 行数請求の仕事 )
8
Akachin @akachin0x0 2015年7月1日
直訳的なのは要らない。 変数名や関数名で分かるようにした方がよさげ…。 別に英語じゃなくてもローマ字でも…いいとは思う…。
0
セオノ@趣味モデラー @Rinforzando_960 2015年7月1日
こう、今回の例題の場合、ソースコードの頭にあるならコメントなくてもいいかもだけど、くっそ長いソースのど真ん中らへんにあったり、他のコードでまで引用してるとか言ったら、コメントないときつい気が……。 変数名で検索すると大量に引っ掛る場合、どこで定義しているかを探すときはコメントで検索した方が早いと思うんだよね、やっぱ。
6
瀬尾 @ceo32038138 2015年7月1日
絶対に必要だとは思わないけど、後で見る人のことを考えたらあったほうが親切じゃないかな、と思って入れてます。今後どれくらいのレベルの人が管理するのかわからない場合は特に。
5
nwoyoshi @nwoyoshi 2015年7月1日
基本書かないけど、前後関係や継承絡みで混乱しそうな時は書く。基本書かない理由は書いてもコメントをメンテすることはめったに無いから
0
きゃっつ(Kats)⊿11/25日向坂ツアー広島 @grayengineer 2015年7月1日
プログラム書いた本人は、書いている時点では「いらねーよ」って思うもんだけど、他人が書いたものを読まされたり、自分が書いたものでもある程度時間が経過していると「あれ、これってなんだっけ?」となりやすく、思い出すトリガとしてコメントはありがたいもんです。自分のために(自分がわからなくなりそうなのを見越して)書くようにしてます
16
きゃっつ(Kats)⊿11/25日向坂ツアー広島 @grayengineer 2015年7月1日
ただ、コメントが正しい保証はないし、逆に変数名や関数名も適切である保証はない(または曖昧で具体性に欠ける場合がある)ので、確実に処理の内容を把握したければ結局はコードそのものを解析しなければいけないのだけど、そのとっかかりになるガイドとしてコメントは(直訳コメントであっても)有用で、解析にかける工数を省く効率化という観点からも必要だと思う
1
smw @Shi_MeiWo 2015年7月1日
習慣として書く。必要なものを書かないよりよほどいい。
0
taQya🍆 @taQya 2015年7月1日
変数名の直訳コメントは要らないと思うけど、関数内の数行の処理のコメントとして「猫の身体測定の結果を設定する」でいくつかのパラメータを代入してるとかならあったほうが良いと思う。でも初心者からベテランまで居る現場だとできるだけ付けてあげた方が、実装した自分への問い合わせが減る分書いた方が楽だと思う
4
(す)🙈🙉🙊 @suto3 2015年7月1日
昔、仕様書のないクソプログラムのバグ取りをするときに、直訳コメントを振ることから初めてコードを整理したことならあります。(意図が分かればコメントを書き直す)分かりやすく整理したらバグは取れましたとさ。で、時間がなかったのでコメントを残したまま納品しました。あれは、後から見直すと「?」となるに違いない。
10
fukus @fukus 2015年7月1日
直訳コメントって if (factoryType.equals("1")) /*工場タイプが1の時の処理*/ みたいな話のことかと思ったら、ちょっと違ってた。
1
大石陽@聖マルク @stmark_309 2015年7月1日
まず「直訳コメントとはなにか」というところの想定の差もあるんじゃないか。「int hensu = 256;」にいちいち「//int型変数hensuに256を入れて初期化する」とか書いてあるのを想定しているならいらない派も出てくるだろうし、逆に参照されている定数やメソッド見に行かなくても概要がわかる程度のコメントを想定しているならあって損はないと思うだろうし。
10
inazakira @inazakira 2015年7月1日
要らない派。こういうコメントはdoxygenの関数ヘッダーに書けばいいと思うの。いまどきのIDEならマウスオーバーでポップアップされるし。呼び出し箇所毎に同じコメント書くのはメンテの工数はバカにならない。コメントがないと分かりづらいコードは設計なり命名に問題があるのでは。
3
taka @taka2002e 2015年7月1日
先にコメントで大まかな流れ書いてから、 実装する場合もあるけどそういう場合は最初のコメント消すんだよね。 つか、やってることなんてコード見りゃわかるからなぜそうしたかを書いて欲しいんだが。
2
終わらない未来 @j_s_br 2015年7月1日
要るって言ってる人たち、どんだけひどい職場で働いてるのかと心配になる
6
山猫@やっぱりだめねこのひと @yamanyanko 2015年7月1日
何をするべきかがメソッドのヘッダにあればいいかな。最近の統合環境メソッドのコメント拾ってきて表示してくれるし。 ただ、ノーコメントプログラムに関しては問題外。 そして、ノーメンテナンスも。コピペ繰り返して違うメソッドなのに処理内容や引数が全く違うコードを見たときは眩暈がした
1
まどちん● @madscient 2015年7月1日
コメントそのものが不要派。ソースコードとバイナリ以外は信用するな。
0
A0-Key(現実逃避中) @sambar_gamer 2015年7月1日
変数・関数・オブジェクト定義時の「これはナニモノか」「引数は何か」位は有っても害は無いと思う。 あと変則的な処理する時に「なぜそうするのか」はあるべきかとw
0
てるもとちひろ@趣味混雑系エンジニア🐰 @ninjin515 2015年7月1日
コメント書かないといけないプログラミングは設計ミスってるっていう思想には賛成するんだけど、ベースが英語なので目がすべる人多々だろうし、国内ならコメント書いたほうが後々役立つと思っている。当時の自分の技術力を下回る人がメンテする可能性だって捨てきれないし。
3
しりうす @SiriusArc7 2015年7月1日
「コードレビューが人格攻撃に思えて怖い、嫌になる」って言う人の気持ちがわかるツイートがいくつか見える
5
Heyw65kZ4RiU @29zgJQepexzZ 2015年7月1日
コメントは要らない派の人間に仕様書すらない糞コードを投げつける神々の遊び
10
はんてん @ryorage 2015年7月1日
何のためにその処理をしているかというコメントは必要だと思いますよ。コーディングしている人にとっては作っている最中は当たり前の処理でも、あとから見て「何これ」というのは多々あります。あとPGじゃない人でも時と場合によってソース追わないといけない場面とかもあるので、そういうのに備えるというのもありますね。
7
はんてん @ryorage 2015年7月1日
ホント人によってはすごくトリッキーなコーディングをする人がいますけど、そういう人に限ってコメントを全く書かなかったり…
2
しょーた @shota243 2015年7月1日
これが要るか要らないかの論争である点に驚愕する。 直訳コメントなんて邪魔だから書くなの一択なのに。 - コードと同じなので内容が正しくて情報量ゼロ、コードと食い違っていれば混乱するだけ。 - コメントにコードが埋もれて見難くなる。 - 特に直訳コメントで1行塞がれると替わりに画面から追い出されるコードがあって全体が把握しづらくなる。 コード理解の妨げにはなるが助けになることは無い。
9
にせれぶ @2celeb 2015年7月1日
「初心者のために」「日本語よりわかり易い」とか言う意見が多くて驚愕する。初心者が悪いとかじゃなくてレベルが低い人に合わせてたらいつまでたっても成長しないと思うんだけど。コードを読む習慣をつけたほうがいいのでは?自分のレベルがどうとかそういうことじゃなくて「もっときれいに」「もっとわかりやすく」を求めて行きたいですね。
4
こっぱみじん😈 @paoohn 2015年7月1日
英語だと読めないから日本語コメントが要るってんなら、識別子の名前を日本語にしちゃえばいいじゃん、今時、結構な言語で使えるでしょ。読める人間からすると、命名規約が酷くて謎英語な識別子使われてたりすると、頭混乱するんだよね…。
1
こっぱみじん😈 @paoohn 2015年7月1日
あと、命名がわかり辛かったらコメント欲しいって人、アセンブリで各行にコメントがあったらどう思うのかな?
1
じぇーでぃーさん@がんばらない @j_doby 2015年7月1日
コメントに書くべきは「意図」であって直訳ではないと思う。
12
Kota Mizushima (on a diet) @kmizu 2015年7月1日
居る派要らない派に分かれることがそもそも疑問。コードみればわかることをコメントに書くなよと思う。英語が読めない人のため~という意見も散見されるが、コードに書く英語なんて中学生高校生レベルでもわかる英語にするだろ普通、と思う。
2
雅@戯雅 @Galakuta09 2015年7月1日
一年くらいした後に見ても、変数名その他から容易に処理が推測できると判断すれば入れない。そうでない場合、また、他人が読む必要がある場合はその基準を甘くする。コメントあっても損ではない。
4
Kota Mizushima (on a diet) @kmizu 2015年7月1日
j_s_br 完璧に同意します。あと、「コードを意訳したコメント」が必要かどうかの話なのに、コメント一般が必要かどうかに話拡大してるのは日本語読めてない。
7
trycatch777 @trycatch777 2015年7月1日
例ならば、仮に入力項目が身長だとして、オブジェクト$catに取得した身長をセットするなんてどんなプログラマーが見たってわかる話なんでコメント不要ですよ。こんな簡単なコードも読めない人はプログラマーとしてダメだから適正から見直しか更なる努力を、で終了。で、お題は「ソースコードを直訳したようなコメント」に話が限定されているから「不要」でファイナルアンサー。皆さんが言及しているパターンはほとんどが別のケースであると思います。
5
Kota Mizushima (on a diet) @kmizu 2015年7月1日
trycatch777 お題が「ソースコードを直訳したようなコメント」に限定されているのに、それ以外の話始めちゃうの、読解力に問題ありなのではないでしょうか。それか、この機会に持論を展開したいだけか。
3
はなだ☆のぶかず@lisp &ボドゲ勢ボドゲプレイヤー) @nobkz 2015年7月1日
コメントは必要だが、下らないコメントはいらない。「直訳したようなコメント」はたいてい、下らないコメントである。よって、直訳したようなコメントは大抵の場合は要らない。
4
まどちん● @madscient 2015年7月1日
英語読めないような奴はコードも読めないので配慮不要。
1
きょん@キョン死ー @nyaago69 2015年7月1日
直訳コメントはじゃまだし、書くのが当たりまえだと読みやすいコードを書くモチベーションを下げちゃう。
0
こっぱみじん😈 @paoohn 2015年7月1日
[c2002119] ioctlを単発で呼び出さなきゃいけない時とか?普通はいくつもセットで呼ぶと思うから、なんで単発でこの場面で呼ぶのかっていう「理由」な気がするから、直訳コメントにはならないか…
0
きょん@キョン死ー @nyaago69 2015年7月1日
もちろん背景説明が必要なところとか、特殊なことやってるコードにはコメントつけた方がよい。(時に敗北感をもちつつ書く)
0
Kota Mizushima (on a diet) @kmizu 2015年7月1日
ところで、直訳コメントどうしても書いちゃうーてな人は、仕方ないので日本語で $猫->高さを設定($入力データ); と書けばいいんじゃないだろうか。今どきのプログラミング言語ならUnicodeを識別子として使えるのは珍しいことじゃないし。
3
keyray @Keyray7 2015年7月1日
え、あとでコメントを機械的に抽出したのを詳細設計書として提出するとかじゃなくて?
1
SHINOHARA Tadashi @zeran 2015年7月1日
直訳コメントって、プログラミング言語ではなく、日本語でしか考えてないからつけたくなるんじゃないの? たとえるなら、自信のない英訳文章の1行ごとに日本語の原文をはさむようなもん。つまり自分の英作文能力の無能さの証明。 そんなものに頼らないと意味がわからないようなソースなんて読みたくないな。 想像しただけでゾッとするけどなぁ、オレは。
2
AtsukoOrikasa @Rutice_jp 2015年7月1日
別に書いてあってもいいと思う。 ていうか、どちらかというと書く派。
0
KZRNM @naminodarie 2015年7月1日
「PHPerはクソ」って言うのを聞いてたときは「PHPはクソ言語だけどそんな言うほどかな」と思っていたけど、このまとめを見てPHPerはクソだと確信しました。
3
KZRNM @naminodarie 2015年7月1日
$cat->setHeigth($inputData)でコメントないと理解できない人はプログラミングに向いてないのでさっさとやめて別の仕事についたほうが良いと思います
6
かえでこ @KaedekoSakura 2015年7月1日
1.まず日本語で記述して、2.そこにコードを被せ、3.日本語をコメントとして残す、という人ならいるけどな。その是非は置く。
0
hatano @_hatano_ 2015年7月1日
x = 10; // xに10を代入する というコメントが要る/書きたいという人はさすがにいないよね? 直訳ってこのレベルの話だと思うのだが
4
asaok @asao_jp 2015年7月1日
この二行を読む限りでは、要らない。ただ、この前にゴチャゴチャっと前処理があったとして、 // ここで猫の身長を設定!!! ぐらいは書く場合はあるかもしれない。
2
かえでこ @KaedekoSakura 2015年7月1日
少しでも必要性を感じるようなコメントには「それは直訳じゃない」という定義分類をして、それで「要らない」と言うのは、ただのトートロジーだよね。可読性が増す人と、邪魔な人が居る時に、こんなの必要な類はコードに関わるな、そも向いてねぇという条件まで付いたなら、そりゃ「要らない」。
3
近藤 和宏 @kondoujp 2015年7月1日
return 0; // 0 を返す を書く派がこれだけいる事に絶望を禁じ得ない
8
かえでこ @KaedekoSakura 2015年7月1日
自信満々に、「私のコードは可読性が抜群で必要なコメントしかない」と言う人の書くコード(それも業務レベルの)読んでみたいなぁ。
12
かえでこ @KaedekoSakura 2015年7月1日
でもあれか、「読めない奴はレベルが足りない」になるのか。
5
きゃっつ(Kats)⊿11/25日向坂ツアー広島 @grayengineer 2015年7月1日
KaedekoSakura 確かに、仕事で目にしたものの中で、コメントが少なくて読みやすかったコードというのはほとんどお目にかかったことないかも
3
KIMATA RobertHisasi @robert_KIMATA 2015年7月1日
正味 "コードを直訳したコメント" は書いたら駄目派。コード修正時にコメントもセットで直さねばならなくなるし、それが漏れるとコードとコメントが乖離してむしろ理解を妨げる
2
みなか@9月30日アカウント閉鎖 @minaka_saikyo 2015年7月1日
コメントはつけるべきだが変数定義までつけるのはやりすぎ
0
Gothicgaze @Gothicgaze 2015年7月1日
保守や改修を経た結果、最初の目的を忘れたコードが書かれることがあって、そういう場合には書いてあるコメントと書いてあるコードの処理が食い違ってたりしてて、そこが要注意ポイントだとわかることはある。「count--; // ここでインクリメント」みたいな
1
明月 @quotient_moon 2015年7月1日
直訳したコメントはいらないし、書くなら機能を抽象化したものであるべき。例えば「xを2乗した数からaを引いて、2倍したxで割り、元のxとの差を新たなxとする」よりも「ニュートン法での平方根を求める」と書いた方が良い
8
まどちん● @madscient 2015年7月1日
コメント要る派の人は自分の書いたコードを読むのが日本人しかいない前提なのかしら。
0
まどちん● @madscient 2015年7月1日
KaedekoSakura コメントがコードの可読性を上げることはあまりないけど下げることはよくあるので、コメント要らないからと言って可読性が高いとかそういう話ではない。
0
はっとりおくりは猫を食べる @hattori_okuri 2015年7月1日
コメントはソースを読む上でのインデックスのようなものだから、まず量的に適切である必要がある。その上で内容に優先度付けて取捨選択すると、直訳コメントは少ししか残らない。処理の目的、判定値の業務的な意味合い、実装方式の採用理由など、前後数行から読み取れない内容が優先される
0
大石陽@聖マルク @stmark_309 2015年7月1日
quotient_moon その厳密さを求めると、例としてあがってる画像は直訳ではないとならないか? みんなそれが直訳であるという基準で論じていると思うんだけど。コードのどこにもクラスやメソッドや変数が何に該当するかの説明はないわけだし。
0
NiKe @fnord_jp 2015年7月1日
コード読めば分かることなら当然要らないですけど、『猫の身長に入力データをセット』というこの例って本当にコードだけで分かりますかね? そもそも猫の「身長」ってなんなのかな?体長なの?体高なの?
1
bbn @6a600n 2015年7月1日
かなり尖っている人がいるが一体どうしたというのか... 直訳コメントに親を殺されでもしたのか...
4
こっぱみじん😈 @paoohn 2015年7月1日
まるで「コードを翻訳したコメント」が各行についてるコードには読みやすいコードがあるみたいじゃないか…それこそ見たことねーよ
2
未知神明(みちがみ・あきら) @ontheroadx 2015年7月1日
(ネコに体長・体高はあっても身長はないのでは?)
2
とりっく☆すたぁ @trickstar1982 2015年7月1日
自分は考え方が逆。 先ずコメント(日本語)で動作の流れを書いて、それからコードに翻訳する。
2
daishi_hmr @daishi_hmr 2015年7月1日
直訳でなくとも「翻訳」コメントであるなら要らない。 意図を説明するコメントを書こう。
0
メゾP @mezzo_p 2015年7月1日
つけない派。コメントはある程度の処理にまとめて付けるので。ただし難解なコードは一行でもコメントを書く(そんなコード書きたくはないが・・・)
0
未知神明(みちがみ・あきら) @ontheroadx 2015年7月1日
(ネコにlength(体長)とwithers height(体高)はあっても、身長はないので、heigthはコメントが必要なのでは? 身長はheightというの使ってもいいの? heightnyanとかにしなくても?)
0
KZRNM @naminodarie 2015年7月1日
仮にlengthとwithers heightを区別する必要があったとしても、その説明を書くのはheight変数(仮)の定義時あるいはSetHeightメソッドの定義時に書く話であって利用時にそんなもん毎回書くな
3
saimushi (L2Rフランツ鯖ふれあ★マギカ) @saimushi 2015年7月1日
自分は書かない派だが、なんにせよ「べき」と言い切ってしまうのは良くないですよね。画一的に決める事でも無いと思うので、べきとは言わないけども僕が書かない理由は返って混乱を招きそうだからかなぁ。このレベルでコメント書いちゃうと、じゃあなんで他は書かないの?いつ何処まで書くの?と、他のエンジニアを惑わせてしまいそうなので、レベル感を乱れさせない為に取り敢えず先ずは書かない。書いてと 頼まれたら書く。かな。
0
まどちん● @madscient 2015年7月1日
「処理しないことを明示する」とか「TODOリスト代わりにする」くらいでしかコメント使わないけど特に困ったこともない。
0
未知神明(みちがみ・あきら) @ontheroadx 2015年7月1日
(この場合、「Heigthは猫の身長(って何かわからないけど、それの定義)」ってコメント入れておかないと、他の人とか未来の自分が何のことかわからなくなるってことないの?)
0
まさらっき @masarakki 2015年7月1日
コメント自体ほぼ書かない
0
KZRNM @naminodarie 2015年7月1日
ontheroadx 『(って何かわからないけど、それの定義)』という箇所の「プログラミングにおける『定義』の意味を理解してないけどとりあえず何か言っておこう」って感じがとても好きです。
4
ナイアル @nyal013 2015年7月1日
信じられないほど読解力のない馬鹿と、信じられないほどバカげたことをやらかす馬鹿が職場にいる場合、操作内容も意図も詳細にコメントに残すべきである。そして、現場には往々にしてそういう奴らがごろごろいる
3
垂木いすゞ @Isuzu_T 2015年7月1日
おかねをいっぱいくれるほうをしじします
0
未知神明(みちがみ・あきら) @ontheroadx 2015年7月1日
naminodarie わからないのは「猫の身長」という語とその定義です。
0
KZRNM @naminodarie 2015年7月1日
ontheroadx そんなものはクラスの定義時にHeightの扱いについて決めてればいいだけで製作者の勝手
2
ゆんゆん探偵 @yunyundetective 2015年7月1日
プログラマの一般原則:コーディング規約の話は荒れる。
7
KZRNM @naminodarie 2015年7月1日
アイコンが同じカットな人のまとめ出されても……
1
whch @white_chal 2015年7月1日
コメントには心をこめんと。
8
もうだめぽ @moudamepo150701 2015年7月1日
white_chal ヒソヒソ( ゚д゚)ヤダァ(゚д゚ )ネェ
0
もうだめぽ @moudamepo150701 2015年7月1日
わしゃ、絶対に書けと教えられたぞ
0
undo(俺の花だよ月見草) @tolucky774 2015年7月1日
猫に身長があるかどうかなんてものすごくどーでもいいと思うし、またそんなことで揉めてるのは糞プロジェクトの予感しかしない
7
water20 @water20 2015年7月1日
どんな処理をやってるのか分かりづらい所に概略書くぐらいならいいけど、変数にコメント書いたりするなら分かりやすい変数名付けた方がマシ。 あと、コメントが正しいとは限らない。コード変更でコメントが実体と合わなくなると、もう惑わすだけの邪魔者でしか無くなるw
2
trycatch777 @trycatch777 2015年7月1日
参画したプロジェクトで「適正なコメント」がついていたりした試しが本当にあるんだろうか。自分は殆ど無いので、「適正なコメント」なんていう幻想は捨てて、レビューで不要と思われるコメントはバッサリいってます。前の人も書いてますが、コードだけ修正してコメントがそのまま残って嘘っぱちになったり、そもそも(コメントが)日本語が不自由で意味不明だったり、そんなコメントなんて邪魔でしかないし、可読性の高いコードを書こうとしなくなるんじゃないかなと思いますね。
0
前橋和弥/ポインタ完全制覇改訂版発売! @kmaebashi 2015年7月1日
著書に『コメントを書くことよりも、「コメントなんかなくても読みやすいプログラム」を書くことに力を入れましょう。そして、奮闘するも力及ばず、どうしてもこれでは後で読んだときに分かりにくくなってしまう、という時に、敗北感に打ちのめされ悔し涙にくれながら、仕方なくコメントを入れる、というのが、コメントに対する正しいスタンスです(やや誇張あり)。』と書いたことがある。(C言語体当たり学習徹底入門)
9
前橋和弥/ポインタ完全制覇改訂版発売! @kmaebashi 2015年7月1日
String userId; // ユーザID なんてコメントを書けと主張する人がいて、何の疑問も持たずに書くプログラマがいるんですぜ。
4
つよし(清野剛) @tseino 2015年7月2日
そこそこベテランの域に入る歳だけど、数年たってから見直したときは「この辺で何してる」とかのざっとしたコメントは欲しいな。直訳コメントはは要らんけどw
1
つよし(清野剛) @tseino 2015年7月2日
デバイスドライバとか書いてると、必要な理由とか不要な理由がコードだけじゃ分からなかったりするから
1
もうだめぽ @moudamepo150701 2015年7月2日
プログラムが書けない人にも、この部分は何のプログラムだと判るようにコメントは書いておけってかけだしの頃に叩きこまれた。
2
ITDOREIKUN @ItDoreikun 2015年7月2日
お、コメントから書く派が居る。俺もそうだ。コメント書き終わったら設計書に貼り付けて体裁整えてプログラマにわたすんや。なお自分でコーディングしたほうが早いのはわかっている
0
Mill=O=Wisp @millowisp 2015年7月2日
自分しか見ないから要らないと思ってたら、5年後の自分に通じなくて困ったことがある
5
Tatsuya SUZUKI @tazyamah 2015年7月2日
言語の種類にもよる(アセンブラとかならコメント需要ありそう)だろうとは思う。殆どの場合は不要だけど、読解する立場に立った時、その場に現れない意図とかを明示しないと目の前のコードがちんぷんかんぷんになりそうなところにはコメントあったほうがいいかなーとおもうので、レビュー時にNOTEコメント追加欲しいとかリクエストしたりとかは極稀にあるようなそんな感じ。
1
ROBA @vjroba 2015年7月2日
直訳コメントなら要らない。全く同じ内容なら原文を読んだほうが早いし正確。プログラミング言語と自然言語では書き表す事象の粒度が異なるので、コメントを書くなら要約しないと意味が無い。
3
ROBA @vjroba 2015年7月2日
正しい命名をしていれば名前に必要な情報が入っているのでコメントが必要になることがあまり無い。正しい命名をするためにもプログラマーには最低限の英語は使いこなして欲しいと思う。
2
ROBA @vjroba 2015年7月2日
あとあんまり関係ない話だけど、修正したら元のコードをコメントアウトして残せって職場がたまにあるが、コメントってそういうものじゃないんで速やかに死んで欲しい。
3
†事実† @n_2i 2015年7月2日
//この行を消すと何故かバグる
3
mikan @anonymikan 2015年7月2日
直訳か否かよりは、ぱっと見で何してるのか分かりにくい行には直訳でコメントしてあったほうが読むときに楽なのではというのはある。この例レベルなら要らないと思うけど、やたら分かりにくい条件式やら正規表現だったりに直訳を書くのはあるかなあ。そこまで読みにくくなるようなコードを書かないに越したことは無いけど。
1
たるたる @heporap 2015年7月2日
5行分くらいの処理の説明を1行コメントで入れることはある。直訳ではなく、いわば概要か意訳だと思うけど。
1
たるたる @heporap 2015年7月2日
「return false; // falseを返す」は稀に見かけるけど、要らない。逆に目障りになってコードの読みの "流れ" が切られる感じがする。
2
nekosencho @Neko_Sencho 2015年7月2日
一人でやるなら好きにすればいいし、多人数でやるなら事前にルール決めとくべきでは
2
すあま @SanmaShioyaki 2015年7月2日
「直訳は駄目」とするよりも「直訳でも良いが控えめに」程度にしておいた方が総合的なカオスの量は減ると思う。ていうか一度「駄目」にしてしまうと、ルール違反をしらみつぶしに消しにかかるタイプの人が結構居てコレがまたカオスの元でな
4
←この人精神年齢38歳らしいよ @MsAgbag 2015年7月2日
Visual Studio使いだけど、インテリセンスクイックヒントつけるようにすることで呼び出し側でこういうコメントを書かなくてもいいようにしてます IDE使うならこういう機能を活用すればいいのだ
0
←この人精神年齢38歳らしいよ @MsAgbag 2015年7月2日
一つの処理をいくつかのフェーズに分割して、そのフェーズではどんなことしてるのか、って書き方はするかな
0
ゆうXV@シンフォギアライブ延期デェース! @yu_takezawa 2015年7月2日
これがいるって言ってる人は、素直にこう書いたらいいんじゃないですかね。 $猫->身長を設定する($入力データ);
1
こっぱみじん😈 @paoohn 2015年7月2日
tazyamah ここでの議論は「コードを翻訳したコメント」ですよ。アセンブリ言語でそんなもん必要ですか?例えばZ80でよく使われたテクニックで XOR A ; AレジスタとAレジスタの排他的論理和を計算してAレジスタに格納する なんてあったらブチ切れですやん
2
こびわ⚒ @kobiwa_net 2015年7月2日
私の場合はケースバイケースです。例えば動きがわかりづらいメソッド名だったりすると「//~を引数に××する」みたいなコメントを書くことが有ります。
0
かえでこ @KaedekoSakura 2015年7月2日
いや、「要る」側の主張は意味ないと思うよ。必要になるだろう要件を満たすと「直訳コメント」から外れるんだから。
3
もな(ง ˙ω˙)ง@砂肝うま太郎 @mona_3588 2015年7月2日
入門書に沿って言語を学んでる時は、普段の勉強でノートを汚す感覚で書きまくりましたね。
3
大石陽@聖マルク @stmark_309 2015年7月2日
KaedekoSakura まず例として挙げられている画像は「直訳コメント」に当たると思う? 思わない? 俺は、その場のコードに含まれないメソッドの内容や変数に格納されているものの来歴、クラスの指しているものなどが含まれていても直訳であるというなら、相当広い範囲まで直訳コメントに含まれると思うんだけど。
1
unimog @frescano 2015年7月2日
「直訳」がどのレベルまでかという議論はあるが、糞コーティング規約と低レベルレビュアーのせいで、コメントレビューだけで時間切れが何回もあるので、いっそ何もない方がとw
0
勇者よっしー @yossiy7 2015年7月2日
ある程度「コードを書く経験」をすると要らない派になるんだろうけど、ある程度「他人が書くコードメンテの経験」を積むと、ベテランでも必要派に転ぶと思う。 直訳だろうと何だろうと、意図が全く推察できない謎コードは世の中にありふれていて、それは有能・無能とは違うレベルで、多分文化が違うというか、生まれ育った環境が違うとかそういう事が起因してる事が多々ある。 結局、コメントを書くという文化を広げないとプログラマの仕事は楽にならない。
4
ロリ兄🚩 @kerolinq 2015年7月2日
仕事で書いているプログラムは、仕様書などをひとまとめにしておける規模を越えてしまっているため、 他と明らかに違う処理をしているところでは、そこでの処理が何を意味するのか、日本語でコメント書くようにしている。 そうしないと仕様がとっちらかって訳が分からなくなってしまう
0
marumushi @marumushi2 2015年7月3日
まとめで言ってる直訳コメントっていうのは、ソースコードで流れも変数の意味も十分追えるのにわざわざコメント付けるケースのことだと思うんだけど、変数名が意味不明ならいる、スパゲッティならいるとかはそもそも議論がズレてないか?
1
猿田彦 @saru_ta_hiko 2015年7月3日
このくらい直訳だとコメントを付けないけど、途中で煮詰まると先に書かなかった部分にコメントを書いて、気を紛らわす。よって、コメントが多いソースは途中で苦労したんだなぁ~と後で思い出す。
0
qyen @9yen 2015年7月3日
初心者がメンテするかもしれないから直訳コメントとか、ベテランがクソくだらないコメント書いてる手間賃でもっとまともな新人雇えよとしか言い様がない。なんでそんな不毛な時間の使い方をするんだろう。
1
Kenrow 改二特 @KenrowY 2015年7月3日
私の場合は「コメント」とゆうより「アウトライン」としてこうゆうコメント残してる場合が多いですね。コメントが先に有って、後からそれに沿ってコードを書いたと。大半は最終的には消しちゃいますが。
0
@aron_aloha 2015年7月3日
むかし全くコメントが書いてないコードがあったんでちゃんと書きましょうって言ったら「費用対効果を考えないとお客さんに提案できない」って言われて固まった思い出
0
Ka-Ka @ka_ka_xyz 2015年7月4日
コメント要らないけど、コミットログやチケットに修正を入れた意図だけは明示しといて欲しい。 「失敗したー!!!」とかだけ書かれても困るお
0
Ka-Ka @ka_ka_xyz 2015年7月4日
実装とはまた別に、そういうコードを書いた時の意図はどこかに書いておかないとメンテナが死ぬる。
0
Ka-Ka @ka_ka_xyz 2015年7月4日
「ソースから意図を読み解け」とか言われても、そのソースが意図通りに動いてないからパッチ出すんじゃろっていう
0
Ka-Ka @ka_ka_xyz 2015年7月4日
逆に言うと、意図がかかれてない直訳コメントとか必要とする人居るんかね。
0
sollalice(本垢) @sollalice 2015年7月4日
ソースだけ読んで理解できるものを作るのが筋だが、読めば分かるのに聞いてくるアホに対して答えるのが面倒なのでドキュメント代わりにコメントを入れる。今ではコメントから自動でドキュメントも生成できるから提出物としてのドキュメント作成の手間も減らせる。プログラマの三大美徳の”怠惰”からの発想で。
0
ぃめ @ime07 2015年7月4日
何してるのかはテストコードに書けばいい。 rspecなんかはガンガン日本語で書いていいし
0
アルビレオ@炙りカルビ @albireo_B 2015年7月4日
直訳コメントが有効なケースを無理矢理考えたら、スレッド/ロック/トランザクションなどの開始終了みたいに「その行だけ見れば直訳だけど処理の流れの中では重要なポイント」を目立たせる、コメントというよりマーキング的なものならありかもしれない。それ以外のコメントが多くなると目立たなくなって意味ないけど
0
アルビレオ@炙りカルビ @albireo_B 2015年7月4日
見た目は単なる代入文でも、ユニークキーやハンドルみたいな「処理の中では別格に重要なもの」はありうるよね。猫の身長はそれに該当しないと思うけどw
0
honeplus @honeplus 2015年7月5日
「コードに直訳コメント不要」は糞コードや日本人プログラマーの英語力を甘く見てる http://honeplus.blog50.fc2.com/blog-entry-150.html コードを見れば分かるから要らないよ、って人は世の中甘く見てる気がしたので、実際に日々俺のSAN値を削ってくる実例を書いてみた。現実はこんなだから日本人は素直にコメントつけよう(切実
0
衛藤姫和(Hiyori Eto) @eiden_twitver 2015年7月6日
「なにをしてるか」より「なんでやってるか」なんだよなぁ・・・
0
どこにもいない人 @nowhereman17 2016年9月9日
9yen ←これ重要。自分の、自分による、自分のためのコメントなら不要。
0
どこにもいない人 @nowhereman17 2016年9月9日
直訳コメント書くのってコメント要らない派なんだけどね。他人、特に立場が異なる人にとって必要なことを書けって言ったら「iに1を代入する」って書いちゃう人たち。
0
アラブッコさん @bukko_arab 2016年9月12日
程度にもよるけど「この程度のコードを理解できない奴は」って言っちゃうのは、自分でコード書いて開発したシステムやソフトを自分で保守するようなPGじゃないかな。実際は障害は現場で起きてるので、現場の技術力の低い赤の他人が見てもわかるコードかどうかで問題解決までの速度は大きく変わる。
1
bun🍃 @bun3559 2016年9月12日
bukko_arab いいえ、問題解決までの速度はたいして変わりません。なぜなら、どんなコメントであっても基本的には信じないほうがいいからです。あくまでも、プログラムソースコードのみが真実だからです。コードは嘘をつかないって習いますよね?
0
中村俊介 @g_o_finch 2017年10月26日
要るか要らないか悩むくらいならコメント書いておく派。「 iに1を代入する」 なんてのは流石に不要だが、猫の身長はそこまで自明じゃ無い(猫のheight? 常識的には「体高」だけど、擬人化されてれば身長もありうる?)から、僕なら書くな。#height = 体高 って書き方になるかも。
0
ひっぴー・真奈美-千葉 SEの嫁 @Cmndaybyday 2018年7月1日
よくわかんないけどコメント入れたら動いたって報告を受けた現場なら知ってる。
0