今まで出会った，ソースコードに存在にして困ったコメントを教えて下さい．

Question

こんにちは．

どのようなコメントを書いてしまうと困るのか，分からず困っています．
今後，良いコードを書くために，どのようなコメントを書くとまずいのか参考にしたいと考えています．

今まで出会った中で，これはひどかったというようなコメントや存在していて困ったというようなコメントは有りますか？
面白かったコメントというようなものも教えていただけるとうれしいです．

英語でもよいのですが，英語の例の質問は，stack overflowで過去質問されていました．

以上，よろしくお願いします．

Comments

[moke]

stack overflowはこう言う質問OKなんですけど、terateilはだめらしいんですよね、残念なことに
改善要求も兼ねて、terateilタグをつけると許される感があるので、つけてみましょうw

[izkn]

teratailのメタな話題でもないし、本件は完全にただの雑談だと私は解釈する。

[moke]

「雑談許可にしてよ」って言う改善要求も兼ねてタグteratailをつけてみては?って意味です。

[izkn]

理解しました d(^_^o)

[think49]

言語を問わない質問へのタグとしては [プログラミング言語] が妥当だと思います。本質問は [teratail] に関する質問ではありませんので…。

[moke]

私もteratail以外を消せという意味で言ったつもりはないのです

Answer 1

ソースコードが13万行もかかれたファイルを読んでいて、一番最後に
「なお、このファイルは現在使っていません」
という記載がありました。
数百行で気づきましたが全部読んだあとにそれを発見したと思うと・・・

Comments

[退会済みユーザー]

まじかｗｗｗ

[moke]

そんなことあるんですね、死ねる

[s.t.]

delphiでしたよ～。
ただでさえレガシーのリプレイス案件だったのに・・・ﾑｯｷｰｰｰｰ

[PineMatsu]

いたずらに近いレベルwww
でも書いてあるだけマシかな。書いてなかったらどこで使っているのか調べないといけないですからね。
できることなら先頭に書いてくれ、ということですね。

Answer 2

（コメントも含めて）ひどいコードばかり集めた、ウンコード・マニアというサイトがあります。

Teratailはあくまで「問題解決」のための質問サイト、だということだそうです。

Comments

[moke]

私も書こうかと思いましたが
名は体を表すと言いますか、素直に笑えないのが多いんですよね

Answer 3

/**
* @return 〇〇の状態を示す真偽値を返却する
**/
public boolean hoge(){
 すごくたくさんの処理..
 return false;
}

Comments

[root_jp]

これはきつい。。。

[yona]

嘘つきJavadocがあるとIDE上ではしっかりとしたメソッドに見えるからよくわからないバグの原因になることが多いからタチが悪い。

そんなコメントを付けるのはやめましょうって流れなら質問としてはありのような気がします。

Answer 4

int number; /* ﾇﾝﾊﾞｰ */

Comments

[hihijiji]

int numeric /* ぬめりけ */

[moke]

地味にひどい
笑わせることが目的で
コメントを書いていると信じたい

[ozwk]

ちなみに3000行ぐらいある関数の1行で
なんの「ﾇﾝﾊﾞｰ」なのかはどこにも書いてませんでした。

Answer 5

/** ここ何やってるかよくわからない **/

Answer 6

コメントではないのですが、ん十年前に雑誌に載っていたZ80の逆アセンブラコードを吐き出すためのアセンブラソースリストがあったのですが、変数やジャンプ先のラベル全てが「AREA88」（新谷かおる）などのマンガのタイトルになっているコードが有りました。本当に動くのかと打ち込んで動かしてみたところ問題なく動きました。もし動かなかったら、デバッグは大変だったと思います。
記憶が定かでは無いですが、コメントは一切ついてなかったと思います。

Answer 7

最近はあまり見かけないですが
0. コメントが全くないソース（関数の頭に説明すら無い）でドキュメントもない
0. 無意味なコメント

無意味なコメントというのは例えば↓こんな感じ

    a = 0;      // a ← 0
    b = 0;      // b ← 0

aやbを何に使用しているのか、なぜ0にするのかということを書いてくれと。

Answer 8

解決済みですが、

char a[256]; /* この変数は消すな。消すと落ちる */

昔、一度遭遇したコメントです。

Comments

[PineMatsu]

これって、メモリーのオーバーアクセスをこの配列があることで落ちることを防いでいるわけですよね。まともに動いているとは思えない。

[ai_2013_dev]

見た目は、問題なく動いています。
この変数を消すと100%落ちます。