パスワードを忘れた? アカウント作成
この議論は賞味期限が切れたので、アーカイブ化されています。 新たにコメントを付けることはできません。

プログラミングでのこだわり」記事へのコメント

  • コメント (スコア:2, 参考になる)

    by baffclan (9449) on 2004年11月30日 20時12分 (#659766) ホームページ
    面倒でもコメントを書く。

    プログラムなんてカッコイイ物は書けませんが、手間を省くためちょっとしたマクロを書いた時など、
    後で見るとわからなくなることがありました。
    やっぱり、コメントは重要です。
    • Re:コメント (スコア:2, 参考になる)

      by Yakza (13745) <yakza@funifuni.net> on 2004年12月01日 10時59分 (#659988) ホームページ 日記
      下3行は同意だが、上1行は疑問。
      面倒と思って書くコメントほどいいかげんになりがち。
      ヘタしたらコピペの書き換えミスとか古いコメントの改訂忘れで
      嘘になっているようなところもよくある。
      コメントを過剰に義務化するからこうなる。
      だから俺は、複雑な部分,試行錯誤した部分に限定した上で
      詳しく書けと教えてる。
      --

      --
      Ath'r'onならfloatあたりに自信が持てます
      親コメント
      • by yasudas (5610) on 2004年12月03日 0時10分 (#660796) 日記
        >嘘になっているようなところもよくある。

        それはコメントではなくて、虚偽とか間違いってことでは?

        >コメントを過剰に義務化するからこうなる。

        最初の「面倒でも」は義務化されているかは論旨の外だと思うよ。
        嘘を書いてしまう可能性があるから、コメントを書かないという手もありかもしれないけどね。

        >だから俺は、複雑な部分,試行錯誤した部分に限定した上で
        >詳しく書けと教えてる。

        そこで、難しくなってしまったこと、試行錯誤の結果での「これはこうなるから」という理屈ではない
        事を書くのも、危険。
        わたしがやっていた時には、数人で読み合わせをして、コメントの虚偽誤記を含めて、等しく間違いは「バグ」として処理させていた。
        親コメント
    • 基本的には同意できるのですが…
      ソースコードの全行にわたってコメントを書いてあるのは逆効果ですよ。
      見づらくてしかたないのです。

      それでもまだ、内容が論理的なところまで叙述できてればまだ少しはいいのですが…

      // 整数型変数i に0を代入する
      int i = 0;

      なんてコメント書かれてもね…。
      誰に説明しているつもりなんだろうと。

      当人いわく、新人君にもコメントの書き方の見本になるようなコメントを書いたとのこと。
      見事に見本になってます。反面教師の。

      # いいや。IDで。
      親コメント
      • Re:コメント (スコア:3, おもしろおかしい)

        by TvT (19813) on 2004年12月02日 11時49分 (#660461)
        以前こんなコードを仕事で見ました。

        // コメントの始まり
        /*
        ...
        コードの質は推して知るべし。
        ……ええ、そっこーその仕事から逃げ出しましたとも。
        # 書いたのは別の会社のまったく知らない人でした。
        親コメント
      • Re:コメント (スコア:2, 参考になる)

        by calc (16044) on 2004年12月02日 18時40分 (#660628) ホームページ 日記
        >ソースコードの全行にわたってコメントを書いてあるのは逆効果ですよ。
        >見づらくてしかたないのです。

        同意。

        個人的には
        1. 関数の頭には何行でも関数に関する説明を書いていい
        2. 関数内部はいずれかに限り手短にコメントを入れる
        • if文等の分岐条件に関する解説
        • ミスリーディングしやすい部分の補足
        • 仕様上回避できないコンパイル時警告に対する言い訳
        というルールでコーディングしてます。
        このルールで不十分なコメントしか書けない場合はたいてい関数の作り方が腐ってます。
        (ちなみ、いわゆる「しみったれた高速化」は要求されないというのが前提です)
        親コメント
      • by Abendrot (8840) on 2004年12月02日 14時38分 (#660529) 日記
        さすがに今では時代遅れとされている「プログラム書法」(The Element of programing style」 [erols.com]でも戒められていましたね。
        *Don't just echo the code with comments – make every comment count.
        あと、こういうのも
        *Don't comment bad code – rewrite it.
        親コメント
    • by yukichi (12361) on 2004年12月02日 14時49分 (#660532) ホームページ
      自分は、今SAP/ABAPのプログラマなのですが、SAPというのは、大量のDBをバックに持ち、かつその項目名が短縮されて、更にドイツ語由来のものなので、とてもじゃないけど、変数をわかりやすくつけただけでは対応できません。
      そうなると、個々の項目に対してコメントが必須になります。
      よくCOBOLに近い、といわれるので、それを思い浮かべれば良いかもしれません。

      はっきり言って、プログラムは、コメント地獄になります。
      その分、誰でも理解できる言語なんですけどね。
      まつもとゆきひろさんみたいな人が見たら、発狂しそうな言語仕様ですが。
      親コメント

長期的な見通しやビジョンはあえて持たないようにしてる -- Linus Torvalds

処理中...