コメント研究すれ。

**デフォルトの名無しさん** · 2008/03/20(木) 04:03:47

Ｃ言語でコメントを書く時とても迷うよな？

・見易さ
・書き易さ
・分かり易さ
・一貫性（統一性）
・とどけこの思い

とか、何でもいいからいい感じのコメントの書き方を考えませう。

**デフォルトの名無しさん** · 2013/12/25(水) 22:08:22.83

コメントとは忘却という自然の摂理に対するささやかな抵抗である
ただし、そのコメントが現時点でも適切であるとは限らないが・・・

**デフォルトの名無しさん** · 2013/12/25(水) 23:26:17.20

>>131
/*****************************************************/
/* こんな風には左寄せなら別にいいのよ。 */
/* 若干煩いけど保守するの問題ないし。 */
/*****************************************************/

/*****************************************************/
/* それをこんな風に箱型にするなって話。　　　　　　　　　　　　*/
/* コメントを書き換えるときにいちいち空白の調整するコストがバカらしい。 */
/*****************************************************/

/*
　*--------------------------------------------------------
　* こんな風に、一行ずつ閉じない方法もあり。
　*--------------------------------------------------------
　*/

/********************************************************
* こんな風に、囲う方法もあり。
********************************************************/

**デフォルトの名無しさん** · 2013/12/26(木) 00:14:16.31

というか、
/*

*/
これで十分。javadoc形式のときは
/**
*
*/
を使うが。

**デフォルトの名無しさん** · 2013/12/26(木) 00:32:48.55

>>130,133
まず間違いなく個人の不文律なので、同じソースを一人でずーっと保守し続けるという前提が
置けない限り統一が困難。がんばって統一してもルールを決めた本人以外全員が「俺のと違う」
という小さなストレスを感じ続けることになる。元の担当者が居なくなったりするともう誰もうれしくない。

右を閉じるとさらにウザさが際立つ件は >133 の言うとおり。

**デフォルトの名無しさん** · 2013/12/26(木) 20:08:18.83

>>128
これエディタのマクロで箱型枠管理とかしてたんかね？

手作業で管理しつづけてたなら、ある意味尊敬する。

**デフォルトの名無しさん** · 2013/12/26(木) 20:34:04.16

昔は手作業で管理するなんて本質的じゃないところに無駄に手間を掛ける奇習もあったからねぇ。
酷いプロジェクトだと、修正履歴にコメント修正なんて書いてあって該当の修正履歴No.見ると箱型の修正だったり。

**デフォルトの名無しさん** · 2013/12/26(木) 21:32:34.84

>>137
「ソースの桁揃え」コミットよりも酷いけど「コメントを箱型に修正」コミットとかやられるよりはマシ。

**デフォルトの名無しさん** · 2013/12/26(木) 22:48:46.16

>>128
箱型コメがかっこよく見える人がいるらしい。
俺はまだその境地に達していないようだ。

**デフォルトの名無しさん** · 2013/12/26(木) 23:15:20.71

かっこいいというか「見やすい」んだよ
原稿用紙が「見やすい」とされるのと同じ程度の理屈
そういうふうになっていないコメントは「未完成のまま放置されている」のだから、「完成させる」は立派な修正

理屈はきちんと聞いて拾いあげてあげないといかん
だから君の業務プログラマーとしての技術はいつまでたっても

**デフォルトの名無しさん** · 2013/12/27(金) 00:50:11.31

>>140
囲みが無いとコメントが見づらいソースって、あれだろ、どんな処理にも一行ごとに
ぺたぺたコメントが入ってて、さらにひどいときにはそれが全部空行で区切られてるやつ。
説明用のサンプルソースからコピペしてきました、みたいな。

健全なソースなら適切な構造化が前提だし、コメントも前に空行一個置く程度で十分目立つ。

**デフォルトの名無しさん** · 2013/12/27(金) 01:28:31.60

「（うわー右揃えるのかったりー・・・。）」

「（･･･誰も見てない、右の */ 消すなら今のうち！！）」

**デフォルトの名無しさん** · 2013/12/27(金) 08:08:42.69

>>140
>理屈はきちんと聞いて拾いあげてあげないといかん
「俺の考え方と違う！きめえ！俺のほうが正しい！」って一人でブツブツ言って延々再修正してるだけだからな
コミュ障かよ

**デフォルトの名無しさん** · 2013/12/27(金) 14:36:55.33

フォントが等幅じゃない場合があるしなー。
一応フォントが等幅を謳っていたとしても、強調表示とかでズレるエディタもあるし。

**デフォルトの名無しさん** · 2014/01/13(月) 12:20:07.15

コメントはソースの意味を少しだけ忘れた頃に書くのがよい。なにやってんだこいつという第三者の視点で書ける。
そうやっていくうちに第三者の視点（客観性）が身につく

**デフォルトの名無しさん** · 2014/01/14(火) 02:33:51.16

俺はコード書いて3秒で忘れるので

**デフォルトの名無しさん** · 2014/03/29(土) 22:27:22.36

それ、コメント書きながら忘れるじゃん

**デフォルトの名無しさん** · 2014/03/29(土) 23:22:25.32

略
"<th valign=\"top\">sendmailのパス</th><td><strong>[ NG ]</strong>たぶん
<input value=\"${sendmails[$cnt]}\" /> です。たぶんね。たぶんだから。
サーバ指定であればそれが正解です。和田の言うことはどうせ当てになりませんから。
すいませんねほんと。</td>";

略
push @result,"<th valign=\"top\">sendmailのパス</th><td><strong>[ NG ]</strong>
ごめん・・・。和田も頑張ったんだけどさ・・・。そう人生うまくいくもんじゃないよね・・・。
探したよ！必死に！交差点でも夢の中でもこんなとこにいるはずもないのに・・・。
ということで、ホントごめん・・・。サーバ会社の人に聞いてみてください・・・。
生まれてきてごめんなさい・・・。</td>";
}
◆出典
//www.synck.com/contents/download/cgi-perl/mailformpro.html#spec
mailformpro4.1.2/mailformpro/librarys/check/main.cgi

**デフォルトの名無しさん** · 2014/03/29(土) 23:33:20.00

# Comments:
# i read an interesting article many years ago about the effects of
　　drugs on spiders in National Geographic Magazine. %0A
　　it showed webs woven by spiders ""under the influence.""
　　spiders high on marijuana wove bad webs;
　　spiders on LSD wove exceptionally geometrical webs.%0
　　Aanyone know how i can locate the date of and
　　issue this appeared in?%0A %0Amany thanks in advance to someone
　　who has walked at least a mile in my shoes.

**デフォルトの名無しさん** · 2014/03/30(日) 00:16:27.97

何年か前に興味深い本を読んだんだ。
ドラッグが蜘蛛に及ぼす影響ってやつをナショナルジェオグラフィックマガジンで。

それには蜘蛛が”ラリった”状態でどんなふうに巣を張るのかが書いてあったんだ。
大麻でラリった蜘蛛は最悪な巣だった。
LSDでラリった蜘蛛はとても幾何学的な巣を作っていた。
だれか予言できるか？このプログラムが問題を起こす日付けを。
あ　そうそう　こんな長いこと素足で長く歩かせてくれただれかさんに有難うって
言っとかなくちゃあなぁ。

◆出典
//search.cpan.org/~softdia/Tie-Eudora-0.01/lib/Tie/Eudora.pm

**デフォルトの名無しさん** · 2014/03/31(月) 05:23:20.27

どうすればコメントのないコードを書くことができるか、というようなテーマの本は
結構出ているものだろうか。

**デフォルトの名無しさん** · 2014/04/08(火) 01:36:05.04

>>151
アセンブリからさらにわかりやすくした高水準言語は
十分に人間が読めるのでコメントなどいらないという思想だな。高水準言語至上主義。
アスペはコード読むよりコメント読むほうが苦痛だというがほんとかねｗ
まあいくらプログラミング言語の表現力がましても
やはり一般人には自然言語のほうがわかりやすいと思うわ

英語をベースにしたコメント言語を作るとかは？

**デフォルトの名無しさん** · 2014/04/08(火) 10:36:53.78

>>152
読み手がどうとかいうよりさきにコメンドの内容によるだろ
無意味だったり間違ってたり関係無かったりするコメント読むよりはコード読むほうが楽だろJK

**デフォルトの名無しさん** · 2014/11/09(日) 04:12:05.56

ソースコードのところどころに無関係なコメントを忍ばせるのが俺流。
// 今日は帰りに焼きそばを買って帰る
とか書いてる。

**デフォルトの名無しさん** · 2014/11/09(日) 06:53:10.50

コメントは見出しみたいな物だ。何をしてるのか１行で自然言語で書かれていればソースコードのみより
明らかに読みやすい。

**デフォルトの名無しさん** · 2014/11/09(日) 09:44:07.78

>>155
実際それが目的なんだけどな
コピペが放置されてたり、そもそもコメントが無かったりで
「毎行コメント書くべし」なんてルールが出来て、
こんなコメントが量産される訳だ

i++;　//ループカウンタをインクリメント

**デフォルトの名無しさん** · 2014/11/09(日) 09:50:25.62

某でかいとこの案件で、毎行コメント書けって言われて
無能しかいねーんだなと思ったな。

**デフォルトの名無しさん** · 2014/11/09(日) 10:02:14.16

まあ、デカいとこになるとさ、エンジニアではない有象無象のオペレータ向けの
ルールにせざるを得なくなるから仕方ないのかな～とは思うけど、
やっかいなのはこういうデカイとこ特有のくだらないルールを見て
何でも右習えでドヤ顔で小規模チームにも適用したがるアホなマネージャ連中だ

出来る人向けのルールとしては、GoogleのC++のが結構参考になる、かな？
あそこは例外禁止だけど

**デフォルトの名無しさん** · 2014/11/09(日) 10:05:41.82

以前に毎行コメント書けなんて言うデカいところのコードレビューで、
「構造体は代入出来ないからmemcpyで書き直せ」なんて言われちったよ

レビュアーがこういうレベルだから変なルールを作らないといけないのか
変なルールで固めて考えさせないから、こういうレベルに育ってしまうのかね…

**デフォルトの名無しさん** · 2014/11/24(月) 01:07:35.04

/* テスト　*/

**デフォルトの名無しさん** · 2015/02/28(土) 08:46:56.17

エレメンタルプログラミングのすゝめ
ttp://takeshik.org/blog/2015/02/28/elemental-programming/

**デフォルトの名無しさん** · 2015/03/28(土) 18:43:37.83

>>161
けっこう面白い

**デフォルトの名無しさん** · 2015/09/25(金) 08:17:05.49

>>156
何のカウンタなんだよw

**デフォルトの名無しさん** · 2016/01/27(水) 20:50:32.13

コードをそのまま言葉にしただけのコメントは可読性を下げるだけだな。

**デフォルトの名無しさん** · 2016/10/08(土) 08:50:39.94

コメントって難しい

**デフォルトの名無しさん** · 2016/10/10(月) 14:22:13.01

>>164 コードをそのまま言葉にしただけのコメントは可読性を下げるだけだな。
激しく同意する。

コメントは概要を知らせるもの。詳細についてはソースを見ればよい。ソース全部を見
渡す前に迅速にそのコードの概要を知らしめるコメントであるべき。

**デフォルトの名無しさん** · 2016/11/02(水) 08:53:02.08

>>156
ひどいルールだな