「良いサンプルコード」を考える

最近、技術書を読んでいると「完成形から逆算された、書き手にとって嬉しいコード」によく遭遇しています。 これが自分の理解ステップと噛み合わず、自分はこうだと嬉しい、といっても文句だけいうのも良くないと思い、自分の思う良いサンプルコードをまとめてみようと思います。 先に言っておきます。自分も自分の要求を全部同時に満たすことはできません。また、普段が自分が書くものは想定読者は自分として手を抜いています。手間を書けたとしても、一定以上の文量で必ず手間や実現性の部分でトレードオフが発生します。 自分の考える良いサンプルコード 最小スタート ステップ毎に何らかの動的/静的検査で検証できる。TDD だと望ましい 一度のコード追加は20行あたりが上限 上から順にコピペするとモジュールが動作する 最小スタート これは何らかのコンパイラを想定した適当なサンプルコードで、良い点悪い点両方あります。 // BAD

[yarumato]

“書き手は完成形から提示したい（後で使う変数もあらかじめ定義）。読み手は困る、使わないまま先に進むから。　一つのファイルに全てが押し込まれていると読み手は楽。コードも全文載せたいが、紙の紙面だと”

[shingo-sasaki-0529]

わかりみが深い。完成形から切り取られた一部を徐々に見せられるよりは完成までの道のりをトレースするほうが写経には向いてそう。でも本の場合は紙面が全然足りなくなりそうだなぁ。

[razokulover]

Writing an Interpriter in GoとかruiさんのCコンパイラ本とかはよく出来てる

[ABA]

サンプルコードは変なデッドコードが無いように少しずつ追記すると分かりやすいという話。エラーが出るコードから例示するのは初心者向けには分かりにくいかもしれんが、まずTDDを理解してもらえば問題ないか