リーダブルコード その2

メイン記事

こんばんは!

一週間お疲れ様でした!

今日は昨日の続きでリーダブルコードの続きをまとめていきます!

<読んでる本>

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

<前回記事>

それでは張り切っていきましょう!

3章 誤解されない名前

名前をつける時には誤解される要素がないか疑ってかかろう。

例えばfilterという単語では選択するのか、排除するのか分かりにくい。→用途に合わせselect,excludeを使用する。

限界値を定める場合は以上なのか、未満なのか分かりにくい。→min,maxと不等号を合わせて表記する。

範囲を決める時には、最初と最後を含む場合はfirst,lastを、最後を含まない場合はbegin,endが推奨される。

名前に使用する単語には、各々が先入観を持ってイメージをしてしまう場合があることを覚えておく。

最良の名前には誤解されないことが大切である。

4章 美しさ

美しいと感じる物は自然と見ていたいと思うように、コードも美しく書くことで読みやすく、理解されやすい。

意識することとしては、書き方に一貫性を持たせること。

同じ意味合いのものを並べるときは同じ形で並べる。

どれかを規則から外れた方法で書いてしまうと読み手には意図せず例外として伝わったり、目立ってしまったりする。

また並べ方にはアルファベット順であったり、優先順序であったり、同じ物は固めるなど、これにも一貫性を持たせることでストレスなく読むことができる。

5章 コメントすべきことを知る

チームで開発する上でコードへのコメントは非常に役立ちます。

でもコメントを読むにも時間がかかります、なんでもかんでもコメントすればいいってものでもありません。

例えば、コードを少し読めばわかることはコメントする必要がありません。

また、名前から推測しにくいからコメントではなく、その場合は名前の方を修正すべきです。

では逆に良いコメントとはどんなものでしょう。

それはコードを書いているときの自分の頭の中の思いや意図です。

また、これは業務でも使われていましたが、TODO:として後に改善すべきことを残しておくのも良いですね。

そしてやはりここでも大事になるのは、読み手の立場になって、誤解を招きそうな箇所、はじめてアサインされた人に向けて簡単に全体像を伝えるコメントも良いコメントになります。

てことで今日は5章まで!続きはまた明日!

2021.2.5 ガオ

コメント

タイトルとURLをコピーしました