リーダブルコードの勉強会へ向けた資料作りとアウトプット Part4

公開日:2019-08-01
最終更新:2019-08-01

第4章美しさ

優れたコードは目にやさしいものでなければならない。
なので以下の3つの原則が成り立つ。

  • 読み手が慣れているパターンと一貫性のあるレイアウトを使う。
  • 似ているコードは似ているように見せる。
  • 関連するコードをまとめてブロックにする。
    美しさと優れた設計は独立した考えだが、できるかぎり両方を追求したいものだ。

まとめ

  • 複数のコードブロックで同じようなことをしていたら、他も似ているようにみせる外観作りが必要だ。
  • コードの縦の線を空白などを使い整理すれば、概要が把握しやすくなる。
  • 並び順は統一。ある場所ではABC、ある場所ではBCAではいけない。
  • 大きなブロックをコメントを使い意味のある(論理的な)「段落」に分ける。

個人的好みと一貫性

コードの開きかっこの位置などの好みはある。
が、このスタイルをバラバラに使ってはダメだ。
一貫性は、時にスタイルの「正しさ」よりも大切になる。

コードを「段落」に分割する

文章は段落に分けているのに、コードになると短縮するのはなぜか。
段落の意味を分かっていないからだ。
段落は主に以下3つの意味がある。

  • 似ている考えをグループにまとめて、他の考えと分ける。
  • 視覚的な「踏み台」を提供できる。
  • 段落単位で移動できるようになるから。
    段落ごとに適切なコメントをつけ、読む気になるコード作りを心がけよう。

    宣言をブロックにまとめる

    コメントをつけて意味のある論理的なブロックにまとめて配置しよう。すると必要な宣言のみよめば済む。

    一貫性と意味のある並び

    コードの並びはランダムでも問題はない。
    しかし、情報を探す際の手間が断じて楽になる。
    以下は著者があkンが得た並び順の例だ。
  • 対応するHTMLフォームの<input>順に並べる
  • 「最重要」なものから並べる
  • アルファベット順に並べる

縦の線をまっすぐにする

=の位置やカンマの位置を空白を使って縦にそろえよう。
するとタイプミスや、ほしい情報をすぐに見つけやすくなる。

メソッドを使った整列

ヘルパーメソッド(よく分かっていないけれど、これを使うと便利に短縮できるらしい要見直し)で重複しているメソッドを排除する。
例えばCheckFullName("","","");のようにする。
そうすればこれのほかにデータが羅列しても引数もすっきりと分かる。

一貫性のある簡潔な改行位置

一貫性がある改行と整理されたコメントは、コードへ楽に目を通すことができる。仮引数や扱う数値が複数羅列するようなコードには、簡潔な表組にデータが並ぶようにする。

なぜ美しさが必要なのか

プログラミングのほとんどはコードを読む時間だ。
ならば、流し読みできるほど整理されたコードを作るべきだ。

記事が少しでもいいなと思ったらクラップを送ってみよう!
29
+1
@NowBridgeがひたすらアウトプットします。

よく一緒に読まれている記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう
目次をみる

技術ブログをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

技術ブログを開設する

Qrunchでアウトプットをはじめよう

Qrunch(クランチ)は、ITエンジニアリングに携わる全ての人のための技術ブログプラットフォームです。

Markdownで書ける

ログ機能でアウトプットを加速

デザインのカスタマイズが可能

技術ブログ開設

ここから先はアカウント(ブログ)開設が必要です

英数字4文字以上
.qrunch.io
英数字6文字以上
ログインする