リーダブルコーディング技術スレ

**デフォルトの名無しさん** · 2013/10/11(金) 01:06:21.56

リーダブルコードとは

・読みやすさ、理解しやすさを追及したコードのことです
・読みやすいということはメンテナンス性も高いということです。
・理解しやすいコードはコードレビューも楽になります。
・理解しやすいコードはバグも少なくなります。
・短いほうが優れていることが多いですが、必ずしも短いほうがいいとは限りません。

俺ルール
・書き方の勝負であり、言語の勝負をしないでください。
・標準、非標準に限らずライブラリを使いましょう。
・なければ自分で関数を作りましょう。関数はなるべく汎用的に。

こういうコードを読みやすくするにはどうすればいいでしょうか？
というようなことを語るスレ。需要ありますかね？

**デフォルトの名無しさん** · 2013/10/24(木) 22:25:41.04

自分のスレって何だ？

**デフォルトの名無しさん** · 2013/10/24(木) 22:30:08.34

三人称単数ならgetsだろ藁（）
小学生かお前ら核爆（）

**デフォルトの名無しさん** · 2013/10/24(木) 22:40:56.38

>148
メンバからの呼び出しの場合

**デフォルトの名無しさん** · 2013/10/24(木) 23:07:37.25

>>139
new Foo や Foo.new は「適度に短い」からリーダブルだよ
なぜなら、new というキーワードによって、単なるメソッド呼び出しと
コンストラクタ呼び出しを一目で見分けられる、
つまりコードリーディングを配慮した言語設計だと言える

それに対して、Foo() は「極端に短い」からアンリーダブルだね
なぜなら、前後の文脈を確認しなければ、それがメソッド呼び出しなのか
コンストラクタ呼び出しなのかが区別できない
つまりコードリーディングを無視した
「一文字でも短くタイプするとかいう変な宗教(>>131)」に従った言語設計だと言える

たとえば、f() というコードは一見するとメソッド(または関数)呼び出しに見える
しかし、その前の文脈に f = Foo があれば、f() の意味はコンストラクタ呼び出しになる
もしも、これが new f または f.new であれば迷うこと無くコンストラクタであると判断できる

**デフォルトの名無しさん** · 2013/10/24(木) 23:09:12.24

> それに対して、Foo() は「極端に短い」からアンリーダブルだね

なんで？ Foo()という関数は読みづらいか？

**デフォルトの名無しさん** · 2013/10/24(木) 23:10:31.80

ていうか、何でコンストラクタと普通の関数を区別する必要があるの？
馬鹿なの？

**デフォルトの名無しさん** · 2013/10/24(木) 23:11:09.04

メソッドとかコンストラクタと言ってる時点で
わかってないやつじゃないか。

このスレで言う、リーダブルとは
技術の低いやつに合わせることではないって
話と同じことだな。

**デフォルトの名無しさん** · 2013/10/24(木) 23:11:54.80

newFoo = Fooって書けばよくね???

**デフォルトの名無しさん** · 2013/10/24(木) 23:18:11.87

アホがアホのフリをする必要は無いぞ。

**デフォルトの名無しさん** · 2013/10/24(木) 23:31:48.54

そもそもオブジェクト指向とかゴミだろ藁（）
OCaml最高！！

**デフォルトの名無しさん** · 2013/10/24(木) 23:37:35.84

Objective Caml ........

**デフォルトの名無しさん** · 2013/10/24(木) 23:38:57.24

第一級のモジュールができて
完全にオワコンになったOCamlのO

**デフォルトの名無しさん** · 2013/10/24(木) 23:40:51.03

一時のブームに流されたばかりに.....

**デフォルトの名無しさん** · 2013/10/24(木) 23:41:59.24

おまえら、ここは言語の勝負するスレじゃないぞ

**デフォルトの名無しさん** · 2013/10/24(木) 23:47:53.68

if !flag vs. unless flag 派のたたかいはまだですか

**デフォルトの名無しさん** · 2013/10/24(木) 23:50:39.18

論理的にはどちらか一方あればいいけど、
読むことを考えれば、両方できる方がいい。

**デフォルトの名無しさん** · 2013/10/24(木) 23:51:21.06

のってやろう
俺は!を見逃すという凡ミスでハマったゴミクソ野郎なので
unless派だ

**デフォルトの名無しさん** · 2013/10/24(木) 23:52:16.44

実装は同じになるけど、英語の意味は違うよ
だから両方ある方がいい

**デフォルトの名無しさん** · 2013/10/25(金) 01:24:29.19

if not でいいじゃん

**デフォルトの名無しさん** · 2013/10/25(金) 10:07:22.11

条件式は明示的に比較演算子を記述すること

**デフォルトの名無しさん** · 2013/10/25(金) 10:22:07.23

俺みたいな雑魚が until と unless を間違えるから、どちらかを別の単語にすべきだ。

**デフォルトの名無しさん** · 2013/10/25(金) 11:01:11.16

if修飾子が好き。
条件の文字をxで置き換えて書くと

next if xxxxxx
next if xxxxxxxxxxxx
next if xxx

と揃っていて美しい。一瞬でこの一群の目的が分かる。
旧来の方法だと、

if (xxxxxx) next
if (xxxxxxxxxxxx) next
if (xxx) next

こうなって、この一群が同一の目的を持ってることがスグには分からない。

**デフォルトの名無しさん** · 2013/10/25(金) 11:35:26.92

>>168
すみません。このnextっていうのは何のことですか？

**デフォルトの名無しさん** · 2013/10/25(金) 11:45:26.35

>>163
そう言うやつはそのうち unless !flag と書いてはまるので、俺は unless いらない派

**デフォルトの名無しさん** · 2013/10/25(金) 11:49:51.98

>>169
C で言うところの continue じゃね？
perl とかが next だったような気がする。

**デフォルトの名無しさん** · 2013/10/25(金) 11:56:20.11

>>168
同じ目的ならor条件にしろ

**デフォルトの名無しさん** · 2013/10/25(金) 12:31:03.71

一人だけ周回遅れな発言してるなぁ…

**デフォルトの名無しさん** · 2013/10/25(金) 20:13:24.30

条件によりオプショナルなら前置
null対策などで仕方なく条件を付けるのなら後置

みたいに書いたりしないか

**デフォルトの名無しさん** · 2013/10/25(金) 23:00:46.24

>>168
こうすりゃいいやん

if (xxxxxx)　　　　　 next
if (xxxxxxxxxxxx) 　next
if (xxx) 　　　　　　 next

**デフォルトの名無しさん** · 2013/10/25(金) 23:24:53.78

変数宣言でそれやってるやついるな。

**デフォルトの名無しさん** · 2013/10/26(土) 00:49:23.99

変なタイプミスした行をあぶりだすのに、それがいいときもある。
状況しだい。

**デフォルトの名無しさん** · 2013/10/26(土) 12:52:26.30

getterでretunr文の位置合わせるのはやりすぎ？

**デフォルトの名無しさん** · 2013/10/26(土) 12:59:11.00

そういうタイプミスをみつけやすくしたいという意味？

**デフォルトの名無しさん** · 2013/10/26(土) 16:11:57.24

int getSpamSpamSpam() {return spam;}
int getHam() {return ham;}
int getEggEggEgg() {return egg;}

int getSpamSpamSpam() {return spam;}
int getHam() {return ham;}
int getEggEggEgg() {return egg;}

下のほうが見やすい気がするけど，同僚からは不評

**デフォルトの名無しさん** · 2013/10/26(土) 16:15:01.79

スペース纏められてたw

**デフォルトの名無しさん** · 2013/10/26(土) 16:17:35.98

int getSpamSpamSpam(){return spam;}
int getHam() {return ham;}
int getEggEggEgg() {return egg;}

int getSpamSpamSpam() {return spam;}
int getHam()　　　　　　　　{return ham;}
int getEggEggEgg() 　　　　{return egg;}

こんな感じか？

**デフォルトの名無しさん** · 2013/10/26(土) 16:25:30.69

ふつうの等幅フォントのエディタで書いてコピペしてくれた方が、
navi2chでは見やすいんだが

**デフォルトの名無しさん** · 2013/10/26(土) 21:25:49.66

名前と括弧の間にスペースを入れて整形するのは変かな？

**デフォルトの名無しさん** · 2013/10/26(土) 22:35:48.73

変

**デフォルトの名無しさん** · 2013/10/26(土) 23:00:18.20

変かどうかっていうのは、オープンソース、
それも有名で多くの人が参加しているようなものの
コードをみればいいだけ。

こういうのは考えるのではなく、調べて答えを見つけようぜ。

**デフォルトの名無しさん** · 2013/10/26(土) 23:03:48.33

変
イテレータならものによっては改行とスペース入れてそろえる

**デフォルトの名無しさん** · 2013/12/03(火) 11:00:09.00

>>182
もっと名前の長い関数を追加することになったら面倒だろ

**デフォルトの名無しさん** · 2013/12/04(水) 01:09:35.65

関数の中身を見比べる必要がある時点でおかしいだろと思った

**デフォルトの名無しさん** · 2013/12/05(木) 07:45:11.65

達人プログラマでも同じようなインデントしてたし
>>182はそこまで変ではないのでは？

**デフォルトの名無しさん** · 2013/12/06(金) 01:25:03.50

見た目云々より、エディタの矩形選択とかを活かせるメリットの方が大きい気が。

**デフォルトの名無しさん** · 2013/12/29(日) 23:04:49.03

クラスの中のある関数をつかうために
あらかじめいくつかの要素をsetしておかないといけないという設計はよくない？
setしないで関数を呼び出したときには例外を出す感じ

コンストラクタにいれてしまったほうがいいんだろうか？

**デフォルトの名無しさん** · 2013/12/29(日) 23:06:02.09

>>192
うん。
何か気に入らないの？

**デフォルトの名無しさん** · 2013/12/29(日) 23:59:47.76

>>193
コンストラクタの引数に不正な値をいれたときの処理が気になる
コンストラクタの中で例外だすのってありだっけ？
そうするとインスタンス生成してから使うところをtryで囲まないといけないし

**デフォルトの名無しさん** · 2013/12/30(月) 00:03:01.47

>>194
ありだよ。

「tryで囲まないといけない」ってのも疑わしいが、それがほんとだとしても
「setしないで関数を呼び出したときには例外を出す」ってしたときと何が違うんだ？

**デフォルトの名無しさん** · 2013/12/30(月) 00:20:47.15

try {
____a = A()
____a.set(something)
____a.do_something()
}
か
a = A()
try {
____a.set(something)
}
a.do_something()
の違いだと思ってる
コンストラクタで例外がでるとそのクラスのインスタンスを使うところ
すべてtryで囲まないといけなくない？

**デフォルトの名無しさん** · 2013/12/30(月) 00:21:24.74

a = Noen
try{
____a = A()
}
a.do_something()
にしろってこと？

**デフォルトの名無しさん** · 2013/12/30(月) 01:20:49.83

>>196-197
それでいいんじゃね？

ごく狭い範囲をtryで囲むみたいなレアケースの見た目（いずれにしても残念）を
なんでそんなに気にしてるのか知らんけど。

**デフォルトの名無しさん** · 2013/12/30(月) 02:04:19.44

FactoryMethodパターンもいいかも。

これだったら、値を解析して正しい値だったらクラスを生成して返し、
不正だったらnullか、ヌルオブジェクトパターンでダミーのオブジェクトを返してやるとか色々出来るから。

A create(int youso)
{
if(yousoが正常) return new A(youso);
else return null;
}

class A
{
int _a;
A(int youso) { _a = youso; }
}

**デフォルトの名無しさん** · 2013/12/30(月) 09:03:57.73

>>198
コンストラクタに例外がある場合の書き方がよくわからなかった

>>199
こういう方法もあるのか
参考になります

**デフォルトの名無しさん** · 2013/12/30(月) 11:04:11.99

デザパタの目的はいくつかあるだろうが、
その中で「カタログ化」だの「パターンに名前をつけて共有」だの、
さもそれこそがおいしいという論調には疑問だね。

>>199を見ろよ。何がFactoryMethodパターンだ。
ただのファクトリメソッドじゃねーか。
「インスタンス化をサブクラスに任せる」っていう点を押さえて理解できてない。

**デフォルトの名無しさん** · 2014/04/10(木) 09:43:21.89

>>191
これ

**拳聖ピストン矢口** · 2014/11/13(木) 23:50:19.89

【注目】チョー気持ちいい!
やっぱセクロスするならアイドルっしょ超有名アイドルグループ所属の美少女が衝撃のAVデビュー
アイドルは裏切らないっ！！

https://www.youtube.com/watch?v=XmP1TRsAe88

**デフォルトの名無しさん** · 2014/11/15(土) 06:53:16.50

>>190
変更コストがつらくなってこない？
読みやすさでは>>182も好きなんだけど

**デフォルトの名無しさん** · 2014/11/15(土) 14:58:16.01

>>204
変更コストって言っても
getterでかつ今までの関数名より長いときにしか起こらないし，そこまで気にしなくていいのでは？
1分もかからないっしょ

**デフォルトの名無しさん** · 2014/11/15(土) 16:17:34.44

変更コストよりも
変更したい箇所以外に、並列されてるだけで関係ない行まで修正が発生するのは気持ち悪いと感じる
1行の修正のはずなのにdiffとると何行も出たり　まあオプションで消せるけど

**デフォルトの名無しさん** · 2014/11/16(日) 07:07:37.48

それでタイポして余計なバグが増えて…
ってなったから>>182みたいに揃えるのは止めたなぁ
見栄えだけなら揃えるのが好きだけど

**デフォルトの名無しさん** · 2014/11/16(日) 08:15:35.42

見栄え→読みやすさ

**デフォルトの名無しさん** · 2014/11/16(日) 08:30:50.35

returnの位置を揃えるのとタイポは本質的には関係ないじゃね？

**デフォルトの名無しさん** · 2014/11/17(月) 10:22:10.98

alignみたいなやつで気軽にガンガン揃えられるような環境ができればいいのだろうか

**デフォルトの名無しさん** · 2014/11/19(水) 00:13:58.01

自分は次の３つを結構その時の気分で描いてしまうのですが、どれかに統一したほうがよいとか、ありますか？
こういうのに対するコーディング規約とかも、会社によってはあるんでしょうか？
（ちなみに3は否定を使わない事でif文が素直に読めるかな？という理由で条件を逆にしているだけです）

例1
hash = INVALID_HASH;
if (! data.empty()) {
　hash = ComputeHash(data);
}

例2
if (! data.empty()) {
　hash = ComputeHash(data);
} else {
　hash = INVALID_HASH;
}

例3
if (data.empty()) {
　hash = INVALID_HASH;
} else {
　hash = ComputeHash(data);
}

**デフォルトの名無しさん** · 2014/11/19(水) 00:41:55.06

>>211
hash = data.empty() ? INVALID_HASH : ComputeHash(data);

**デフォルトの名無しさん** · 2014/11/19(水) 05:42:14.41

hash = INVALID_HASH;
hash = ComputeHash(data) if (! data.empty());

**デフォルトの名無しさん** · 2014/11/19(水) 12:53:45.74

>>212
なるほど、代入が１命令で済むなら参考演算子の方が見やすいですよね。
ちなみに複数行にわたる時はどうします？

>> 213
説明不足でした、C言語を想定していました。
ちなみにこの書き方だと、同じ変数に対する代入が二つ連続しているだけのように（ぱっと見）見えませんか？
１行目の代入って無駄じゃね？　と一瞬思わせてからの２行目、みたいな。

**デフォルトの名無しさん** · 2014/11/19(水) 13:24:54.27

俺は>>212じゃないけど、

> なるほど、代入が１命令で済むなら参考演算子の方が見やすいですよね。
代入が1命令というより、代入した後は変数の値を変更しないためだな。
変数は代入文とともに宣言し、その後は変更してはならない。
関数型言語の考え方よ。

なので>>213はだめだね。値を書き換えてるから。

**デフォルトの名無しさん** · 2014/11/19(水) 13:29:08.73

>>214
> ちなみに複数行にわたる時はどうします？

三項演算子でも見やすく書ける。

場合によってはハッシュを使う。
Perlで書くけど、

my $value = {
　key1 => 'value1',
　key2 => 'value2',
　key3 => 'value3',
}->{$key} || 'other';

**デフォルトの名無しさん** · 2014/11/19(水) 20:19:45.26

>>214
>ちなみに複数行にわたる時はどうします？

hash = data.empty() ? (
　　　　INVALID_HASH
　　) : (
　　　　ComputeHash(data)
　　) ;

理屈は >>215、いわゆる参照透明性のことで、
関数型言語や Ruby のような関数型プログラミングに適した言語ならではのコード
・Rubyによる関数型プログラミング
　http://www.h6.dion.ne.jp/~machan/misc/FPwithRuby.html

なお Ruby には C と同様な条件演算子(三項演算子)もあるけど、
複数行にわたる場合には if 式を使うのが普通

hash = if data.empty()
　　　　INVALID_HASH
　　else
　　　　ComputeHash(data)
　　end

**214** · 2014/11/20(木) 00:50:43.10

最初の話しとはズレるんですが、宣言と同時に初期化し、それ以降の代入を極力避ける
というスタイルをC/C++で言い換えると、積極的に const をつける　という事になりますかね。
変数をなるべく const 宣言するというのは、キーワードconstが目印になって宣言箇所がすぐにわかるので
個人的にも好きですね。ただ関数の非ポインタ引数にconstをつけるのは煩わしく思いますが。

**デフォルトの名無しさん** · 2014/11/20(木) 00:55:42.04

それより条件式の比較演算子の省略と条件式内での関数呼び出しをやめてほしい

**デフォルトの名無しさん** · 2014/11/20(木) 11:12:42.88

>>219
それは十分シンプルで十分意味がわかるならば問題ないよ。

いるんだよね。ルールを守ることが目的になってる奴って。

× 書き方を統一しようとする
○ わかりやすいように書く

わかりやすいならば、どんな書き方だっていいんだよ。
どうせ書き方なんて些細な事なんだし。

**デフォルトの名無しさん** · 2014/11/20(木) 11:40:07.19

まあ比較演算子の省略はわかればいいんだけど
if文の条件式で関数呼ばれると単にデバッグが面倒なんだよね
これは別の問題か

**デフォルトの名無しさん** · 2014/11/20(木) 17:57:21.94

えっ

**デフォルトの名無しさん** · 2014/11/20(木) 18:25:29.28

if (func()) { }

ではなく

result = func();
if (result) { }

こういうこと？

**デフォルトの名無しさん** · 2014/11/20(木) 18:35:58.57

比較演算子を省略しないとこうか
result = func();
if (result == true) { }

真偽値だったら省略したくなるな～俺は

**デフォルトの名無しさん** · 2014/11/21(金) 10:27:03.29

そうそう
C言語って既定の真偽値型ないし

**デフォルトの名無しさん** · 2014/11/21(金) 10:53:54.88

ごめんやっぱリーダーブル関係ないね

**デフォルトの名無しさん** · 2014/11/21(金) 13:24:31.65

Cだったら
if (result == true) はダメでしょ。resultが非0かつ非1だったときに困る。
if (result != false) にしないと。
結局真偽値判定は比較演算子使わない方がいいんでない？

**デフォルトの名無しさん** · 2014/11/21(金) 13:47:31.12

真偽値を直接返す関数を作らなければいいのかな

**デフォルトの名無しさん** · 2014/11/21(金) 14:12:52.15

変数名をresultではなく、 doneやcompleteのように状態を表す言葉にすればいい。
if (done) { }

**デフォルトの名無しさん** · 2014/11/21(金) 14:14:08.05

if (expr == TRUE) とか書くのは馬鹿げている、とcomp.lang.c FAQの回答にもある。
http://c-faq.com/bool/bool2.html 単に if (expr) と書くべき。

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

真偽値の場合、doneかisDoneにするかで迷う時がある。

**デフォルトの名無しさん** · 2014/11/22(土) 04:07:44.39

結局どーんすんの

**デフォルトの名無しさん** · 2014/11/22(土) 05:06:36.83

たまにいずどーんにすんの

**デフォルトの名無しさん** · 2014/11/22(土) 11:35:45.69

いやexprは関係演算子以外から導くべきではない、って話だろ

**デフォルトの名無しさん** · 2014/11/22(土) 16:46:09.25

if(variable == undefined)

**デフォルトの名無しさん** · 2014/11/22(土) 19:28:06.50

職場のスパゲティソースのメトリクス値がやばすぎるんで

今度大幅に直そうという話はあがったものの
全く手がついてないんだけど

どういうふうに課員を指導したらいいんだろう

**デフォルトの名無しさん** · 2014/11/22(土) 22:08:19.55

同値変形のやり方を練習させろよ

**デフォルトの名無しさん** · 2014/11/22(土) 22:09:52.26

それは、どうちて？

**デフォルトの名無しさん** · 2014/11/23(日) 08:18:15.22

>>220
こーいう人ってなんなん？

分かりやすいだけがルールじゃないし、
分かりやすい定義が曖昧だから、ルール作って
こーいう意識もってやりましょうってのがルールなのになんで勝手なことするの

**デフォルトの名無しさん** · 2014/11/23(日) 08:46:26.24

そういう人が言う「分かりやすいコード」って
基本的に誤解しやすいコードが多い

**デフォルトの名無しさん** · 2014/11/23(日) 08:59:26.38

>>200がプロだって前提で言うと、
>>200みたいな意見は研究所出身の人に多いね。

で、そういう人の書いたコードは、実際にモノに組み込んで
テストすると大量のバグが露見する(机上、単体テストはOKて言ってたにもかかわらず！)

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

失礼、>>200ではなく>>220でした。

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

>>242
それはルールを守らずに，独自のわかりやすい方法で書いたからってこと？

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

一貫性の欠いたフレームワークなんて作られた日には使えたもんじゃないだろ

**デフォルトの名無しさん** · 2014/11/23(日) 11:55:45.10

独自のわかりやすいコードっていうのを見てみたいわｗ

わかりやすいコードっていうのは、独自じゃない。
多くが○○スタイルみたいな言い方で呼ばれてる。
もちろんいろんなスタイルがあって、わかりやすいスタイルというのは
一つではないが、わかりやすいという点では共通してる。

わかりやすいのに、バグがでまくるとか矛盾してるってｗ

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

C言語で
#ifdef DEBUG
printf(var);
#endif
が1つの関数に頻出するコードは非常に読みにくい

今やらされてる組織内独自のフレームワークのコード