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

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

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

    面倒でもコメントを書く。

    プログラムなんてカッコイイ物は書けませんが、手間を省くためちょっとしたマクロを書いた時など、
    後で見るとわからなくなることがありました。
    やっぱり、コメントは重要です。
    • 基本的には同意できるのですが…
      ソースコードの全行にわたってコメントを書いてあるのは逆効果ですよ。
      見づらくてしかたないのです。

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

      // 整数型変数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.
        親コメント

Stay hungry, Stay foolish. -- Steven Paul Jobs

処理中...