ホーム

スタッフブログ

2024年6月25日

コードレビューでよくある指摘(2)

こんにちは

プログラマー / マネージャー のAです。

 

以前、

コードレビューでよくある指摘(1)という記事を書きましたが

また指摘例が溜まってきたので、追記します。

 

 

進◯郎構文のような「if」を書かない(頻出度★★★)

「私は誕生日に生まれました」みたいなコード、よく見ます。

よくある誤った例と正しい例を記載します。

 

###### ココからコード #####

// 誤った例 …
if( $value === “1” ){
    return true;
} else {
    return false;
}

// 正しい例
return $value === “1”;

###### ココまでコード #####

 

頭の中身をそのままコードに移すと、やってしまいがち。

「if」を使うか使わないか の差ですが、挙動は全く同じ。

ネスト(階層)を無駄に増やす必要はないです。

 

コツとしては、、“return true;” が出てきたら、無駄がないか一度疑ってください。

 

 

辞書が必要な単語を使わない(頻出度★★★)

あなたが分からない単語は、他の人も分からないです。

 

変数名や関数名を見たときに

「パッと分からない」というのは、実は大きなリスクで、

水面下で、不具合の原因になっています。

 

コツとしては、

難しい単語が必要なときは、

一気に色々やりすぎてないかを疑う → いくつかに分けてみる と良いです。

 

日本語でもそうなんですが

難しい単語でも、いくつかのフェーズに分けると、簡単に表現出来ます。

例えば

「邂逅」と言われるとなんのことか分からないですが

「思いがけず、会った」といえば簡単ですよね・・・?

 

 

コピペしない(頻出度★★)

レビューすると、「あ、これコピペだわ」と直ぐに分かります。

で、深く読まずにすぐ差し戻します。

 

コピペで差し戻してるというよりは、

たぶん、よくわかってないけど、動いたからこれで出してきた

と思って差し戻してます。で、だいたい分かってないです。

 

個人的に

「コピペ=悪」とまでは思ってないんですが、どちらかというと否定的です。

「コピペ出来るんなら共通化出来るんじゃね?」って思ってます。

 

あと、

空でコードを書けなくなって、開発のリズムが悪くなる印象です

CSSの 「animation-*」 とか、PHPの 「curl_*」 とか、頑張って書いてます。

例えば

以下の頻出コード、何も見ずに書けますか?

 

1,(PHP)date()関数で、3日前の日時を求めるコード

2,(CSS)display: flex で、横は中央寄せ、縦は下ぞろえにするコード

3,(JavaScript)jQuery.Ajaxのお決まりのコード

 

普段からコピペばっかしてると、多分書けないです。

もし書けないようなら、減らしたほうがいいかなと思います。

 

以上となります。

なるべく差し戻しを減らして、スムーズに開発出来ればな、と思っています。

 

 

求人バナー

このページの上部へ戻る