Skip to content

MS_ReadableCode

Jump to bottom
nishi_74322014 edited this page Sep 1, 2026 · 1 revision

リーダブルコード

概要

移行メモ（未記述）: 「概要」節は元ページでも見出しのみで、
本文が書かれていない。

補足（書籍について）: 『リーダブルコード -
より良いコードを書くためのシンプルで実践的なテクニック』
（Dustin Boswell / Trevor Foucher 著、オライリー・ジャパン、2012 年）を
指している。原著は "The Art of Readable Code"。
「コードは他人が最短時間で理解できるように書かなければならない」
という一文を主題に、命名・整形・コメント・制御フロー・
関数の分割といった具体的な技法を扱う。
下記「詳細」の見出しは、この書籍の章立てにおおむね対応している。

詳細

移行メモ（未記述）: 以下の各節は元ページでも見出しのみで、
本文が書かれていない。
書籍の目次を写した「読書メモの器」の状態で止まっているものと解される。
原文のまま残す（各項目の要点は下記「参考」の記事が詳しい）。

変数の名称

コード自体の見た目

コメント

制御フロー

コードの分割

変数の使い方

コードの抽象化

メソッド

ライブラリ

スピードの改善

その他

補足（章立てとの対応）: 見出しだけでは分かりにくいため、
書籍の構成に照らした要点を添えておく。

本ページの節 書籍での要点
変数の名称 明確な単語を選ぶ。汎用的な名前（tmp、retval）を避ける。スコープが広いほど名前は長く
コード自体の見た目 縦の線を揃える、意味のあるまとまりで空行を入れる、一貫した並び順
コメント 「何をしているか」ではなく「なぜそうしたか」を書く。自明なコメントは書かない
制御フロー 条件は肯定形で、否定の入れ子を避ける。早期 return でネストを浅くする
コードの分割 「無関係の下位問題」を抽出する。一度に 1 つのことをする
変数の使い方 不要な変数を消す、スコープを縮める、一度だけ書き込む
コードの抽象化 汎用コードをライブラリとして切り出す
スピードの改善 「読みやすさ」と衝突する場合は、まず計測してから判断する

なお .NET では、これらの多くが
**アナライザ（.editorconfig、StyleCop、SonarLint）**で
機械的に検査できるようになっている。
「人が心がける」段階から「CI で担保する」段階に移っている点が、
本ページ執筆時との一番の違いである。

参考

Qiita

本 Wiki 内

Tags: プログラミング, .NET開発

このWikiは「Open棟梁Project」,「OSSコンソーシアム 開発基盤部会」によって運営されています。

NetDevInfraWiki

マイクロソフト系技術情報 Wiki
Open 棟梁 Wiki

（未着手）

開発基盤部会 Wiki

移行管理: DONE ／ TODO

Clone this wiki locally