コメント研究すれ。

■ このスレッドは過去ログ倉庫に格納されています
1デフォルトの名無しさん
垢版 |
2008/03/20(木) 04:03:47
Ｃ言語でコメントを書く時とても迷うよな？

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


とか、何でもいいからいい感じのコメントの書き方を考えませう。
2デフォルトの名無しさん
垢版 |
2008/03/20(木) 04:31:32
/* 早く帰りたい */
2008/03/20(木) 05:04:05
>>2
それは多分こっち

マ板：印象に残ったコメントを晒せ　0x04
http://pc11.2ch.net/test/read.cgi/prog/1190866177/

>>1
ていうか迷わない
2008/03/20(木) 05:13:48
//　　 _,,....,,_　 ＿人人人人人人人人人人人人人人人＿
//-''":::::::::::::｀''＞　　　ゆっくりしていってね！！！　　　＜
//ヽ:::::::::::::::::::::￣^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^Ｙ^￣
//　|::::::;ノ´￣＼:::::::::::＼_,. -‐ｧ　　　　　＿_　　 _____　　 ＿_____
//　|::::ﾉ　　　ヽ､ヽr-r'"´　　（.__　　　　,´　_,, '-´￣￣｀-ゝ 、_ イ、
//_,.!イ_　　_,.ﾍｰｧ'二ﾊ二ヽ､へ,_7　　　'r ´　　　　　　　　　　ヽ、ﾝ、
//::::::rｰ''7ｺ-‐'"´　 　 ;　 ',　｀ヽ/｀7　,'＝=─-　　　 　 -─=＝',　i
//r-'ｧ'"´/　 /!　ﾊ 　ハ　 !　　iヾ_ﾉ　i　ｲ　iゝ、ｲ人レ／_ルヽｲ i　|
//!イ´ ,' |　/__,.!/　V　､!__ﾊ　 ,'　,ゝ　ﾚﾘｲi (ﾋ_] 　　 　ﾋ_ﾝ ).| .|、i .||
//`! 　!/ﾚi'　(ﾋ_] 　　 　ﾋ_ﾝ ﾚ'i　ﾉ　　　!Y!""　 ,＿__, 　 "" 「 !ﾉ i　|
//,'　 ﾉ 　 !'"　 　 ,＿__,　 "' i .ﾚ'　　　　L.',.　 　ヽ _ﾝ　　　　L」 ﾉ| .|
//　（　　,ﾊ　　　　ヽ _ﾝ　 　人! 　　　　 | ||ヽ、　　　　　　 ,ｲ| ||ｲ| /
//,.ﾍ,）､　　）＞,､ _____,　,.イ　 ハ　　　　レ ル｀ ー--─ ´ルﾚ　ﾚ´

5デフォルトの名無しさん
垢版 |
2008/03/20(木) 06:50:35
コメントなんて不要
2008/03/20(木) 07:14:12
javadocで書いてるトコ多いんじゃないの？
2008/03/20(木) 09:23:03
バグ直してもついでにコメントを直す奴はいないだろｗｗｗ
コメントはほとんどウソです
書いちゃいけません
8デフォルトの名無しさん
垢版 |
2008/03/20(木) 11:12:49
そういえば本屋でネーミングについての本が売ってた。

ネーミングの掟と極意
http://www.amazon.co.jp/o/ASIN/4798114332/503-8563893-6507141?SubscriptionId=1CVA98NEF1G753PFESR2

わざわざ本を買うほどのことでもないとは思うけど、俺みたいに年中違う会社に行っている下請け屋からすると
変数名、コメントのつけ方に規定がない会社で、コメントや変数名にレビュー指摘を受けると殺意を覚えるな。
例えば

① /* bErrorFlgがtrueならば */
② /* 例外フラグが立っているならば */
③ /* 例外ならばaをbに変更する処理 */
④ /* bErrorFlgがtrueならば中に入る */
if (true == bErrorFlg) {a = b;}

たったこれだけの処理でも会社ごとに①②③④＋αパターンの書き方がある。
自分的には③が好きで処理概要をif文の前にずらずらと書いてしまうほうが好き。
98
垢版 |
2008/03/20(木) 11:34:48
あと、漏れはJavaの業務経験はそれほどないのだが、
get, setの名前のつけ方って何がいいのかわかんない。
例えば同期データの送信を行う処理があって、送信結果が返ってくるとしたら、メソッド名はどうつける？

今のプロジェクトでは以下だが、
/* データ送信結果を取得する */
getSendResult()
getResult()

漏れ的には送信するのがメインの処理で、戻り値はおまけなのだからメソッド名は
/* XXXを送信する処理 */
sendXXXMessage()
sendXXXData()

とかにしたいわけなのさ。誰か教えてエロい人。
2008/03/20(木) 12:01:10
前者は結果をとるだけで、後者は送信も実行するんだからメソッドの内容がちがうんじゃないの？
前者は非同期かなんかで送信は別に呼び出して、その結果を知るために使うものなんじゃ。
2008/03/20(木) 12:06:53
わざわざ true と比較なんてしなくても・・・。

そもそも、エラーなら a を b に変えるということくらいは一目で分かるから
その例だとあまりコメントを書く必要性を感じないな。
書くにしても、a を b に変えることに何らかの意味があるなら、
その意味を書いた方がいい。
2008/03/20(木) 13:19:59
学生時代はmanの文書を手本にしろといわれたな
関数中の変数名やら処理の意味が見て分からないような関数は
とっととリファクタリングしちまえや、と。
2008/03/20(木) 13:40:47
単なる和訳が最低だよね。
int i; /* i を初期化しています */
i=0; /* i に 0 を入れています */
単に同じプログラムをプログラミング言語と日本語で二重に書いているだけ
2008/03/20(木) 13:43:08
なんでひまわり導入しないんだろうな
2008/03/20(木) 13:45:51
>>13
自分の為の覚え書きなんだろうね

そういうの引き継いで、かつ内容が間違ってたりするともうぬるぽ
168
垢版 |
2008/03/20(木) 14:38:02
>>10
私もそう思います。
しかし、今の会社ではどうやら「戻り値」に着目してメソッド名を決めているようだ。
（規約なんかは勿論無い！）

>>11
うっかりtrueと比較する癖が抜けてないなぁ・・・
ちなみにtrueと比較しているのは規約です。
製造業のCプログラム辺りだと
以下の記載が許されない会社の方が多いと思う。
if(bErrorFlg) or if(!bErrorFlg)

boolがintになっても対応可能だからとかいう理由だったような。
if (ERR_STATE_1 == bErrorFlg)

>>13
そういう規約がある会社もあるぞ。
必ず一行につき一行コメントを書けって言う会社。
そういう場合には仕方なく書いた覚えがある。
2008/03/20(木) 14:38:33
>>8
いまだに、if() 文中で定数を左に書いてる奴がいるんだ...
そっちにびっくりだよ。

>>13
> int i; /* i を初期化しています */

初期化してないし。(w
2008/03/20(木) 14:40:08
>>17
>そっちにびっくりだよ。
どうして？？
1918
垢版 |
2008/03/20(木) 14:45:21
と思ったけど分かった
昔の人に多そうなテクだよね
2008/03/20(木) 14:51:21
>>16
だったらtrueと比較するのではなくfalse (0)と比較するほうがいい。
218
垢版 |
2008/03/20(木) 14:56:34
>>18
以下の代入ができてしまうコンパイラや設定が可能らしい。(普通はエラーかワーニングがでるけどね。)
if (bErrorFlg = true) {}

左に書いてあると、確実にエラーになる。
if (true = bErrorFlg) {}

製造業だと今でも普通に使われる規約の一つだぞ。
2008/03/20(木) 15:07:14
>>16
> boolがintになっても対応可能だからとかいう理由だったような。
理由になってないと思うが・・・。
多分、そういう規約作ってる奴もよく分かってないんだと思うぜ。

>>21
そういうこと分かった上で言ってるんだと思うが。
2008/03/20(木) 15:09:01
true と比較しても危険性が増えるだけであまり意味が無い。
どうしてもというなら != false になるが、
これも二重否定で可読性に難があると思う。
2008/03/20(木) 15:11:01
bool から int に変えて、新しくフラグを追加した時にも、
true との比較ならそのままのコードで通るってことじゃないかな。
そのままのコードで放置することがいいことかどうかは知らんが、
フェイルセーフということならありかもしれない。
2008/03/20(木) 15:20:23
むかし「偽以外は全て真の可能性があると心得よ」
とか教わった
2008/03/20(木) 15:23:16
装飾が多いコメントは見づらい
////////////
//むほむほ//
////////////

/***********
　　うはうは
************/
2008/03/20(木) 17:32:34
>>24
if (hoge() == true) ・・・

みたいなソースなのに、hoge()が、bool値を返してなかったら、カオス過ぎるだろ。
2008/03/20(木) 17:36:22
変更はするが、変更洩れがあっても動く、ってことだな。
2008/03/20(木) 18:01:08
bool値のリテラルと比較してるソースってすごい素人くさいよな。
世間で評価されている書籍とか、プロダクツのソースとかで、それをやってるのはすごい少数派。
2008/03/20(木) 22:12:46
スレチの話題で盛り上がってる券
2008/03/20(木) 22:20:12
「コメントに関する無意味な話」になってないだけマ板よりマシ
そういう向きにはマ板のスレが適切
間はない
2008/03/21(金) 15:28:06
/* test code */

条件コンパイル使えって話もｗ
2008/03/24(月) 10:37:21
突っ込みどころを探すスレはここですか?
2008/03/24(月) 21:04:58
関数の説明書きって皆どうやって書いてる？
2008/03/24(月) 21:20:42
規約があればそれに従う。
そうでなければ関数と引数と戻り値の説明を書く。
2008/03/24(月) 21:25:41
それをどう書くか聞いたつもりなんだけど・・・。
2008/03/24(月) 21:27:44
cだとdoxygenizeのjavadocスタイル
javaだとry
2008/07/21(月) 00:29:43
>>36
精子を出す関数
チソチソをマムコに突っ込む
戻り値-精子
2008/07/21(月) 15:58:25
精子を出す関数がマムコに突っ込むのか？
戻り値が精子なら、セクースの実装は分離すべきだろ
副作用についての記述が分離できなくなるし、絡み合い過ぎて再入可能性が損なわれそうだ
再入可能じゃない精子を出す関数なんて大問題だろ
40かばとっと
垢版 |
2009/06/15(月) 18:42:06
年賀状の配達は無事すんだかどうかわかりますでしょうか。
2009/06/17(水) 14:15:18
自分は、DoxygenでJavadoc風の書式を使ってます。
Qt風の書式は余り好きじゃないんで。
2009/06/19(金) 00:07:00
MFCのソースとか見ると、ほとんどコメントなんてついてないよな。
最先端のところでは、コメントを極力書かないのが、主流なの？
2009/08/17(月) 17:46:50
Q. 自動保守#K9K?_D[L　とは一体何なのか？
A. 外部サイトへの突撃大好きな真性厨房

韓国突撃でお馴染みの自動保守
最近は自動焼人 ★として２ちゃんねるのボランティアにも精を出す日々
だがそんな彼にも、人間らしい部分はあったのだ…

名言集
『アパッチ砲はワシが作った』
『お前が規制系キャップ取れるか審査してやるよ』
『いつもサボってばかりのキャップがウゼえ』
『俺、100人規模の集団サイバーテロの主犯だったこともあるんだぜ』
『俺の経歴カックイイだろ？』

最近のニュース
　8月15日の韓国突撃の際に歴史的大敗を喫する。ラジオでの敗戦宣言のときに声が震えていた
　本人は体調不良と言っているが…


----------------------------------------------
この自動焼人 ★メールマガジンの配信停止をご希望される方は
http://qb5.2ch.net/test/read.cgi/sec2chd/1250169591/
にて自動焼人 ★までご連絡ください
2010/03/13(土) 18:29:04
コメントを書くべきか書かざるべきか
http://www.infoq.com/jp/news/2010/03/To-Comment-or-Not-to-Comment
2010/03/13(土) 19:29:54
>>44
> Kelly Leahy氏は、一目瞭然のわずかなコメントが散りばめられているようなコードが好みだ。
この訳はおかしいな。

「ごくわずかなコメントがところどころにある自己説明的なコード」が正解かと。
46デフォルトの名無しさん
垢版 |
2011/05/29(日) 04:16:48.41
１行毎に 「/* */」使ってスペースで「*/」の位置合わせてるコメントとか個人的にかなりウザイんだが…
メンテする時も行端合わせにゃならん気がしてスペース連打、でもメンドくなって 「//」
2011/05/30(月) 12:21:37.58
つ[プロポーショナルフォント]
2011/05/30(月) 18:56:54.58
いや、フォントの問題を言ってるんじゃないと思うが・・
2011/05/30(月) 19:03:46.34
プロポーショナルフォントでカラムを揃える気になるか? つまりはそう言うことだ。
2011/05/30(月) 23:13:14.30
うちには来ないでください
51デフォルトの名無しさん
垢版 |
2011/06/04(土) 14:11:06.33
１行コメで /* */ 使う人って何考えてるの？
2011/06/04(土) 15:32:33.99
C89なんだろ
2011/06/06(月) 01:24:35.92
/*
54デフォルトの名無しさん
垢版 |
2011/06/06(月) 21:36:49.00

うひょおおおおおおお ！！！！
明日から毎日休みだぜぇ～！！

*/
55デフォルトの名無しさん
垢版 |
2011/07/11(月) 20:39:10.82
C89でやってるとこまだあるの？
2011/07/11(月) 20:55:03.80
ネストできないコメントなんて死ねばいいと思うの。
57デフォルトの名無しさん
垢版 |
2011/07/16(土) 14:46:50.89
ブロックコメントで/**/使って箱型にするのやめてくれよ、マジで
2011/07/16(土) 15:40:32.13
ズレを直すためにスペースキーを連打することに恍惚を覚える
2011/07/16(土) 18:07:54.48
ブロコメはソース行頭くらいでしか使う気にならない
2011/07/16(土) 19:04:50.28
必要な処理はすべてプログラム自体にかかれている。
だから、プログラムコードを読んでも、すぐに分からないことをコメントにしてほしい。

例えば、関数の要約とか、そのように処理をしないといけない理由や意図などといったことだ。
それがプログラムの読者が疑問を持った箇所に書かれているならば、良いコメントだ。
2011/07/17(日) 10:30:50.56
まずコメントにして、それをコードに直していく。
だから、コードを全部書き終えるとコメントがなくなる。

仕事は別。
2011/07/19(火) 09:50:31.42
会話もできないやつらにコメントなんか出来るわけない
63デフォルトの名無しさん
垢版 |
2011/07/29(金) 10:42:08.90
カオスラウンジもpixivもしんで。
64デフォルトの名無しさん
垢版 |
2012/02/28(火) 02:04:09.60


/********************************************************/
/*　こういう箱型ブロックコメント、いい加減やめませんか？　　　　　*/
/*　タイプ量増えるしメンテめんどいの判りますよね？　　　　 　　　　*/
/*　後でメンテする人の身にもなってください。　　　　　　　　　　　　　*/
/********************************************************/




■ このスレッドは過去ログ倉庫に格納されています
5ちゃんねるの広告が気に入らない場合は、こちらをクリックしてください。
ニューススポーツなんでも実況