パスワードを忘れた? アカウント作成
12842511 story
プログラミング

Linus Torvaldsが許せないコメントスタイルとは? 28

ストーリー by hylom
争いの種 部門より
headless 曰く、

Linus Torvalds氏がLinuxカーネルのネットワークスタックで使われているコメントスタイルについて、「脳が損傷したバカみたいなコメントスタイルだ」として修正を求めている(メーリングリストでのコメントRegister)。

Torvalds氏はバランスのとれた対称的なコメントスタイルに統一すべきだと考えているようで、以下の(a)~(c)をよいコメントスタイルだとしている。また、Linuxカーネルのスタイルではないとしつつ、許容可能なコメントスタイルとして(d)を挙げている。

(a)
/* This is a comment */

(b)
/*
* This is also a comment, but it can now be cleanly
* split over multiple lines
*/

(c)
// This can be a single line. Or many. Your choice.

(d)
/* This is an alternate multi-line format
that isn't horrible, but not kernel style */

一方、バランスのとれていない最悪なコメントスタイルとしているのは以下の2つ。

(no)
/* This is disgusting drug-induced
* crap, and should die
*/

(no-no-no)
/* This is also very nasty
* and visually unbalanced */

さらに、コメントのボックス化を好む人の話を始めるつもりはないとしつつ、ボックス化したコメントはLSDでラリっていれば本当に素晴らしいものだと思えるだろうが、アステリスクの右端が揃っていることを気にする以上に良いことはないと述べている。

  • by Anonymous Coward on 2016年07月12日 14時43分 (#3045765)

    必要なコメントをまるで書かずソースだけ書くスタイルと、
    ソースが更新されたのに、コメントの内容が古いままのスタイルだ

    それに比べりゃアスタリスクの位置などなんだというのか

    ここに返信
    • by Anonymous Coward

      それ、コメントの内容やメンテナンス体制がおかしいんであって話題とされている記述スタイルとは何の関係もないでは?

      • by Anonymous Coward

        内容(に対するスタイル)がおかしいのに比べれば体裁(というスタイル)なんて、ということでは?

        • by Anonymous Coward

          体裁について話しているのに、内容を持ち出すなよ、ってことでは?
          「あれに比べりゃまだまし」なんて言い始めると話ができないよね。

    • by Anonymous Coward

      文末に読点(。)が無い日本語のスタイルについても考慮して下さい。

      • by Anonymous Coward

        俺は文末にピリオドを打たない英文等のスタイルも許せない。

      • by Anonymous Coward

        統一されていればOK。

      • by Anonymous Coward

        「。」は句点やろが。
        「、」が読点。

        • by Anonymous Coward

          (#3045777)
          しまったー。今まで素で間違えてた。
          スタイルの問題でなく。中身の問題だったか。

    • by Anonymous Coward

      もっと許せないのは

      //iに1を足す
      i++;

      • by Anonymous Coward

        この手のは書いてる本人がよほどの暇人でないかぎりすぐに治るよ。

        コメント書かない奴を矯正するのとは比較にならないほど楽。

        • by Anonymous Coward

          この手のは書いてる本人がよほどの暇人でないかぎりすぐに治るよ。

          コメントをそもそも書かなくなる人もいる。

        • by Anonymous Coward

          //削除 start 2016.07.12
          //iに1を足す
          //削除 end 2016.07.12
          i++;

      • by Anonymous Coward

        そんなのまだまし
        本当に許せないのはこういうの

        //iに1を足す
        i += 2;

    • by Anonymous Coward

      コメントも更新されいるけど、解読が必要な暗号文かよってスタイル

  • by Anonymous Coward on 2016年07月12日 15時02分 (#3045770)

    C99から規格上もOKになったんだしいい加減良いでしょ?と思うかも知れないですが、
    日本語で書いていて文字コードがShift_JISだったりすると、うっかりダメ文字が
    コメント行の行末に来てしまい、行の併合で次の行までコメント扱いになって
    しまうことが。

    ここに返信
    • by Anonymous Coward

      Shift_JIS なんか使うなよ、21世紀も15年も経っているのに。

    • by Anonymous Coward

      いやいやここは
      #でのコメントスタイルの復権をですね

    • by Anonymous Coward

      それはコンパイラが Shift_JIS に対応してないってことでないの?

      • by Anonymous Coward

        厳密に言えばそういうことなんですが、周りのプログラマを見ても
        そこまで気を使ってチェックする人は皆無ですね…

  • by Anonymous Coward on 2016年07月12日 15時07分 (#3045776)

    // よくわからないけど、これ↓を追加したら動いたので消さないで

    ここに返信
    • by Anonymous Coward

      スタック壊れてるんやろうな...

  • by Anonymous Coward on 2016年07月12日 15時10分 (#3045781)

    何の問題もない

    // コメント

    /* コメント*/

    まあ許される

    /*
      * コメント
      */

    /**********
      * コメント
      **********/

    だが一方で、Linusは許せる(b)案や(d)案は許されない。
    無論、Linusが許せないコメントの書き方の方も許されない。

    なんでも、行頭から2文字目がアスタリスクであることを前提に抜き出して整形してくれるシステムを使ってるから、らしい。
    なので、Linusが許せないコメントの書き方でも

    /* コメント
      */

    /************
      * コメント */

    とか書けば多分通る。気持ち悪いけど。

    ここに返信
    • by Anonymous Coward

      ecodeってスペース二文字分入るのか…
      失敗した。

    • by Anonymous Coward

      まさにその、コメントを箱型に収めるのをLinusが嫌ってるようだから。
      箱に収めるのに命かけてきた日本のワープロの使い方が英語圏に理解されないように、
      それは言っても仕方ないと思うよ。

  • by Anonymous Coward on 2016年07月12日 15時11分 (#3045782)

    Emacsで長いコメントをM-qで整形すると、
    (no-no-no)のスタイルになっちゃうんだよね。
    ちょっと手を加えないといけない。

    あと左側のアステリスクも揃っちゃうんだけどそこはいいのだろうか。

    ここに返信
  • by Anonymous Coward on 2016年07月12日 15時25分 (#3045803)

    って、 * で枠を作ってあるやつのこと?
    プログラマ的には一般的な表現なのかな。

    ここに返信
    • by Anonymous Coward

      俺はしないけど、プログラマというより、上からそうしろって言われて
      とかじゃないかなぁ。管理職の人ってなんでも罫線で囲ったりするの大好きだし…

      #一種の強迫観念なんじゃないかと思う

typodupeerror

普通のやつらの下を行け -- バッドノウハウ専門家

読み込み中...