コメント研究すれ。
■ このスレッドは過去ログ倉庫に格納されています
0001デフォルトの名無しさん
2008/03/20(木) 04:03:47・見易さ
・書き易さ
・分かり易さ
・一貫性（統一性）
・とどけこの思い
とか、何でもいいからいい感じのコメントの書き方を考えませう。
0002デフォルトの名無しさん
2008/03/20(木) 04:31:320003デフォルトの名無しさん
2008/03/20(木) 05:04:05それは多分こっち
マ板：印象に残ったコメントを晒せ 0x04
http://pc11.2ch.net/test/read.cgi/prog/1190866177/
>>1
ていうか迷わない
0004デフォルトの名無しさん
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」 ﾉ| .|
// （ ,ﾊ ヽ _ﾝ 人! | ||ヽ、 ,ｲ| ||ｲ| /
//,.ﾍ,）､ ）＞,､ _____, ,.イ ハ レ ル｀ ー--─ ´ルﾚ ﾚ´
0005デフォルトの名無しさん
2008/03/20(木) 06:50:350006デフォルトの名無しさん
2008/03/20(木) 07:14:120007デフォルトの名無しさん
2008/03/20(木) 09:23:03コメントはほとんどウソです
書いちゃいけません
0008デフォルトの名無しさん
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文の前にずらずらと書いてしまうほうが好き。
00098
2008/03/20(木) 11:34:48get, setの名前のつけ方って何がいいのかわかんない。
例えば同期データの送信を行う処理があって、送信結果が返ってくるとしたら、メソッド名はどうつける？
今のプロジェクトでは以下だが、
/* データ送信結果を取得する */
getSendResult()
getResult()
漏れ的には送信するのがメインの処理で、戻り値はおまけなのだからメソッド名は
/* XXXを送信する処理 */
sendXXXMessage()
sendXXXData()
とかにしたいわけなのさ。誰か教えてエロい人。
0010デフォルトの名無しさん
2008/03/20(木) 12:01:10前者は非同期かなんかで送信は別に呼び出して、その結果を知るために使うものなんじゃ。
0011デフォルトの名無しさん
2008/03/20(木) 12:06:53そもそも、エラーなら a を b に変えるということくらいは一目で分かるから
その例だとあまりコメントを書く必要性を感じないな。
書くにしても、a を b に変えることに何らかの意味があるなら、
その意味を書いた方がいい。
0012デフォルトの名無しさん
2008/03/20(木) 13:19:59関数中の変数名やら処理の意味が見て分からないような関数は
とっととリファクタリングしちまえや、と。
0013デフォルトの名無しさん
2008/03/20(木) 13:40:47int i; /* i を初期化しています */
i=0; /* i に 0 を入れています */
単に同じプログラムをプログラミング言語と日本語で二重に書いているだけ
0014デフォルトの名無しさん
2008/03/20(木) 13:43:080015デフォルトの名無しさん
2008/03/20(木) 13:45:51自分の為の覚え書きなんだろうね
そういうの引き継いで、かつ内容が間違ってたりするともうぬるぽ
00168
2008/03/20(木) 14:38:02私もそう思います。
しかし、今の会社ではどうやら「戻り値」に着目してメソッド名を決めているようだ。
（規約なんかは勿論無い！）
>>11
うっかりtrueと比較する癖が抜けてないなぁ・・・
ちなみにtrueと比較しているのは規約です。
製造業のCプログラム辺りだと
以下の記載が許されない会社の方が多いと思う。
if(bErrorFlg) or if(!bErrorFlg)
boolがintになっても対応可能だからとかいう理由だったような。
if (ERR_STATE_1 == bErrorFlg)
>>13
そういう規約がある会社もあるぞ。
必ず一行につき一行コメントを書けって言う会社。
そういう場合には仕方なく書いた覚えがある。
0017デフォルトの名無しさん
2008/03/20(木) 14:38:33いまだに、if() 文中で定数を左に書いてる奴がいるんだ...
そっちにびっくりだよ。
>>13
> int i; /* i を初期化しています */
初期化してないし。(w
0018デフォルトの名無しさん
2008/03/20(木) 14:40:08>そっちにびっくりだよ。
どうして？？
001918
2008/03/20(木) 14:45:21昔の人に多そうなテクだよね
0020デフォルトの名無しさん
2008/03/20(木) 14:51:21だったらtrueと比較するのではなくfalse (0)と比較するほうがいい。
00218
2008/03/20(木) 14:56:34以下の代入ができてしまうコンパイラや設定が可能らしい。(普通はエラーかワーニングがでるけどね。)
if (bErrorFlg = true) {}
左に書いてあると、確実にエラーになる。
if (true = bErrorFlg) {}
製造業だと今でも普通に使われる規約の一つだぞ。
0022デフォルトの名無しさん
2008/03/20(木) 15:07:14> boolがintになっても対応可能だからとかいう理由だったような。
理由になってないと思うが・・・。
多分、そういう規約作ってる奴もよく分かってないんだと思うぜ。
>>21
そういうこと分かった上で言ってるんだと思うが。
0023デフォルトの名無しさん
2008/03/20(木) 15:09:01どうしてもというなら != false になるが、
これも二重否定で可読性に難があると思う。
0024デフォルトの名無しさん
2008/03/20(木) 15:11:01true との比較ならそのままのコードで通るってことじゃないかな。
そのままのコードで放置することがいいことかどうかは知らんが、
フェイルセーフということならありかもしれない。
0025デフォルトの名無しさん
2008/03/20(木) 15:20:23とか教わった
0026デフォルトの名無しさん
2008/03/20(木) 15:23:16////////////
//むほむほ//
////////////
/***********
うはうは
************/
0027デフォルトの名無しさん
2008/03/20(木) 17:32:34if (hoge() == true) ・・・
みたいなソースなのに、hoge()が、bool値を返してなかったら、カオス過ぎるだろ。
0028デフォルトの名無しさん
2008/03/20(木) 17:36:220029デフォルトの名無しさん
2008/03/20(木) 18:01:08世間で評価されている書籍とか、プロダクツのソースとかで、それをやってるのはすごい少数派。
0030デフォルトの名無しさん
2008/03/20(木) 22:12:460031デフォルトの名無しさん
2008/03/20(木) 22:20:12そういう向きにはマ板のスレが適切
間はない
0032デフォルトの名無しさん
2008/03/21(金) 15:28:06条件コンパイル使えって話もｗ
0033デフォルトの名無しさん
2008/03/24(月) 10:37:210034デフォルトの名無しさん
2008/03/24(月) 21:04:580035デフォルトの名無しさん
2008/03/24(月) 21:20:42そうでなければ関数と引数と戻り値の説明を書く。
0036デフォルトの名無しさん
2008/03/24(月) 21:25:410037デフォルトの名無しさん
2008/03/24(月) 21:27:44javaだとry
0038デフォルトの名無しさん
2008/07/21(月) 00:29:43精子を出す関数
チソチソをマムコに突っ込む
戻り値-精子
0039デフォルトの名無しさん
2008/07/21(月) 15:58:25戻り値が精子なら、セクースの実装は分離すべきだろ
副作用についての記述が分離できなくなるし、絡み合い過ぎて再入可能性が損なわれそうだ
再入可能じゃない精子を出す関数なんて大問題だろ
0040かばとっと
2009/06/15(月) 18:42:060041デフォルトの名無しさん
2009/06/17(水) 14:15:18Qt風の書式は余り好きじゃないんで。
0042デフォルトの名無しさん
2009/06/19(金) 00:07:00最先端のところでは、コメントを極力書かないのが、主流なの？
A. 外部サイトへの突撃大好きな真性厨房
韓国突撃でお馴染みの自動保守
最近は自動焼人 ★として２ちゃんねるのボランティアにも精を出す日々
だがそんな彼にも、人間らしい部分はあったのだ…
名言集
『アパッチ砲はワシが作った』
『お前が規制系キャップ取れるか審査してやるよ』
『いつもサボってばかりのキャップがウゼえ』
『俺、100人規模の集団サイバーテロの主犯だったこともあるんだぜ』
『俺の経歴カックイイだろ？』
最近のニュース
8月15日の韓国突撃の際に歴史的大敗を喫する。ラジオでの敗戦宣言のときに声が震えていた
本人は体調不良と言っているが…
----------------------------------------------
この自動焼人 ★メールマガジンの配信停止をご希望される方は
http://qb5.2ch.net/test/read.cgi/sec2chd/1250169591/
にて自動焼人 ★までご連絡ください
0044デフォルトの名無しさん
2010/03/13(土) 18:29:04http://www.infoq.com/jp/news/2010/03/To-Comment-or-Not-to-Comment
0045デフォルトの名無しさん
2010/03/13(土) 19:29:54> Kelly Leahy氏は、一目瞭然のわずかなコメントが散りばめられているようなコードが好みだ。
この訳はおかしいな。
「ごくわずかなコメントがところどころにある自己説明的なコード」が正解かと。
0046デフォルトの名無しさん
2011/05/29(日) 04:16:48.41メンテする時も行端合わせにゃならん気がしてスペース連打、でもメンドくなって 「//」
0047デフォルトの名無しさん
2011/05/30(月) 12:21:37.580048デフォルトの名無しさん
2011/05/30(月) 18:56:54.580050デフォルトの名無しさん
2011/05/30(月) 23:13:14.300051デフォルトの名無しさん
2011/06/04(土) 14:11:06.330052デフォルトの名無しさん
2011/06/04(土) 15:32:33.990053デフォルトの名無しさん
2011/06/06(月) 01:24:35.920054デフォルトの名無しさん
2011/06/06(月) 21:36:49.00うひょおおおおおおお ！！！！
明日から毎日休みだぜぇ～！！
*/
0055デフォルトの名無しさん
2011/07/11(月) 20:39:10.820056デフォルトの名無しさん
2011/07/11(月) 20:55:03.800057デフォルトの名無しさん
2011/07/16(土) 14:46:50.890058デフォルトの名無しさん
2011/07/16(土) 15:40:32.130059デフォルトの名無しさん
2011/07/16(土) 18:07:54.480060デフォルトの名無しさん
2011/07/16(土) 19:04:50.28だから、プログラムコードを読んでも、すぐに分からないことをコメントにしてほしい。
例えば、関数の要約とか、そのように処理をしないといけない理由や意図などといったことだ。
それがプログラムの読者が疑問を持った箇所に書かれているならば、良いコメントだ。
0061デフォルトの名無しさん
2011/07/17(日) 10:30:50.56だから、コードを全部書き終えるとコメントがなくなる。
仕事は別。
0062デフォルトの名無しさん
2011/07/19(火) 09:50:31.420063デフォルトの名無しさん
2011/07/29(金) 10:42:08.90■ このスレッドは過去ログ倉庫に格納されています