リーダブルコード：4章 美しさ

※TODOあり

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

上記書籍をまとめと自分の考えを記載します。

美しさ

インデントを揃える。

この点はエディタやIDEに任せてしまえばいいと思います。

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

すべてのメソッドを1つの大きなブロックにまとめるのではなく、論理的なグループに分けてあげるとよいとのことです。

単純ですが以下にC#でサンプルを記載します。

改善前

public class File
{
  public static File Open(string filePath);
  public void Write(byte datas);
  public void Close();
  public void Write(char datas);
  public void Write(string datas);
}

改善後

public class File
{
  public static File Open(string filePath);
  public void Write(byte datas);
  public void Write(char datas);
  public void Write(string datas);
　public void Close();
}

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

コードを段落に分割すると以下のように改善されます。

※ todo サンプルを考える。

改善前

public class File
{
  public static File Open(string filePath);
  public void Write(byte datas);
  public void Close();
  public void Write(char datas);
  public void Write(string datas);
}

改善後

public class File
{
  public static File Open(string filePath);
  public void Write(byte datas);
  public void Write(char datas);
  public void Write(string datas);
　public void Close();
}

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

ただ、私は段落ごとにprivateメソッドを用意してコメントを無くす方が良いのではないかと考えます。

改善すると以下のとおりです。

public class File

{
  public static File Open(string filePath);
  public void Write(byte datas);
  public void Write(char datas);
  public void Write(string datas);
　public void Close();
}

この問題については「大切ではない詳細はユーザから隠し、大切な詳細は目立つようにする」という設計原則の観点で選択すればいいと思います。
(この設計原則については本書P181に記載されています。)