Linus Torvaldsが許せないコメントスタイルとは? 28
争いの種 部門より
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でラリっていれば本当に素晴らしいものだと思えるだろうが、アステリスクの右端が揃っていることを気にする以上に良いことはないと述べている。
もっと許せないコメントスタイルはある (スコア:0)
必要なコメントをまるで書かずソースだけ書くスタイルと、
ソースが更新されたのに、コメントの内容が古いままのスタイルだ
それに比べりゃアスタリスクの位置などなんだというのか
Re: (スコア:0)
それ、コメントの内容やメンテナンス体制がおかしいんであって話題とされている記述スタイルとは何の関係もないでは?
Re: (スコア:0)
内容(に対するスタイル)がおかしいのに比べれば体裁(というスタイル)なんて、ということでは?
Re: (スコア:0)
体裁について話しているのに、内容を持ち出すなよ、ってことでは?
「あれに比べりゃまだまし」なんて言い始めると話ができないよね。
Re: (スコア:0)
文末に読点(。)が無い日本語のスタイルについても考慮して下さい。
Re: (スコア:0)
俺は文末にピリオドを打たない英文等のスタイルも許せない。
Re: (スコア:0)
統一されていればOK。
Re: (スコア:0)
「。」は句点やろが。
「、」が読点。
Re: (スコア:0)
(#3045777)
しまったー。今まで素で間違えてた。
スタイルの問題でなく。中身の問題だったか。
Re: (スコア:0)
もっと許せないのは
//iに1を足す
i++;
Re: (スコア:0)
この手のは書いてる本人がよほどの暇人でないかぎりすぐに治るよ。
コメント書かない奴を矯正するのとは比較にならないほど楽。
Re: (スコア:0)
この手のは書いてる本人がよほどの暇人でないかぎりすぐに治るよ。
コメントをそもそも書かなくなる人もいる。
Re: (スコア:0)
//削除 start 2016.07.12
//iに1を足す
//削除 end 2016.07.12
i++;
Re: (スコア:0)
そんなのまだまし
本当に許せないのはこういうの
//iに1を足す
i += 2;
Re: (スコア:0)
コメントも更新されいるけど、解読が必要な暗号文かよってスタイル
C++スタイルの 1行コメント ( // ) を許容するか (スコア:0)
C99から規格上もOKになったんだしいい加減良いでしょ?と思うかも知れないですが、
日本語で書いていて文字コードがShift_JISだったりすると、うっかりダメ文字が
コメント行の行末に来てしまい、行の併合で次の行までコメント扱いになって
しまうことが。
Re: (スコア:0)
Shift_JIS なんか使うなよ、21世紀も15年も経っているのに。
Re: (スコア:0)
いやいやここは
#でのコメントスタイルの復権をですね
Re: (スコア:0)
それはコンパイラが Shift_JIS に対応してないってことでないの?
Re: (スコア:0)
厳密に言えばそういうことなんですが、周りのプログラマを見ても
そこまで気を使ってチェックする人は皆無ですね…
コメントスタイル以前の問題 (スコア:0)
// よくわからないけど、これ↓を追加したら動いたので消さないで
Re: (スコア:0)
スタック壊れてるんやろうな...
うちの社内ルール (スコア:0)
何の問題もない
まあ許される
だが一方で、Linusは許せる(b)案や(d)案は許されない。
無論、Linusが許せないコメントの書き方の方も許されない。
なんでも、行頭から2文字目がアスタリスクであることを前提に抜き出して整形してくれるシステムを使ってるから、らしい。
なので、Linusが許せないコメントの書き方でも
とか書けば多分通る。気持ち悪いけど。
Re: (スコア:0)
ecodeってスペース二文字分入るのか…
失敗した。
Re: (スコア:0)
まさにその、コメントを箱型に収めるのをLinusが嫌ってるようだから。
箱に収めるのに命かけてきた日本のワープロの使い方が英語圏に理解されないように、
それは言っても仕方ないと思うよ。
Emacsのデフォルト (スコア:0)
Emacsで長いコメントをM-qで整形すると、
(no-no-no)のスタイルになっちゃうんだよね。
ちょっと手を加えないといけない。
あと左側のアステリスクも揃っちゃうんだけどそこはいいのだろうか。
コメントのボックス化 (スコア:0)
って、 * で枠を作ってあるやつのこと?
プログラマ的には一般的な表現なのかな。
Re: (スコア:0)
俺はしないけど、プログラマというより、上からそうしろって言われて
とかじゃないかなぁ。管理職の人ってなんでも罫線で囲ったりするの大好きだし…
#一種の強迫観念なんじゃないかと思う