超読みにくいプログラムコードから見えた読みやすさの秘訣
＊この記事は、「リーディング・ライティング講座」にご参加のお客様に書いていただいたものです。
記事：村人F（リーディング・ライティング講座）
皆さんは、自分の書いた文章が読みにくいと怒られたことはあるだろうか。
僕はある。メチャクチャある。
自分が読めば理解できるんだけど、他の人からはわからないと言われる。
でもどう直せばいいか全然わからない。
そういった経験をしたことのある人はたくさんいるはずだ。
そんなときには別の世界に目を向けてみるのがいい。
プログラミングの世界はそのいい例だと思う。
プログラミングではプログラムコード、略してコードと呼ばれる英語みたいな文章を書きまくっている。
このコードが尋常じゃないほど読みにくいのだ。
どれくらい読みにくいか。
まず自分が読めない。それもわずか1週間前に書いたコードが、だ。
そしてそんな謎の文章を数十人で数万行書いているのである。
それゆえ、内容を理解する時点で大仕事。結果的に仕事時間がメチャクチャ増えて終わらない残業地獄、通称デスマーチが延々続く。
それくらい読みにくいのだ。
そんなコードを読みやすくするための必殺技が詰まった本が、今回紹介する本、「リーダブルコード」だ。
この本には、読者が最速で理解できるコードを書くためのテクニックがたくさん詰まっている。
たとえば、「変数」という値を入れるための文字列がある。
変数をxとした場合、「x = 1 + 2;」のように使う。
この変数の名前は自由に付けられるんだけど、読みにくいコードはその名付け方が下手なのだ。
具体的には「x」や「a」みたいに、それだけじゃ意味がわからない名前を使ってしまうのである。そして数万行のコードの中に、その「x」が色んな意味で100個ぐらい出てくる。
これじゃあ読みにくいのは当然だ。
だから本書では混乱しないように、お金の計算結果だったら「money_sum」みたいに、変数名だけで意味がわかる単語を付けましょうということが書いてある。
こんな感じでコードを読みやすくする方法が本書には書いてあるんだけど、ここから2つの秘訣が見えてくる。
1つ目は、単純なことをちゃんとやるのが大事ということだ。
先程の変数の例を見て思ったかもしれないが、この本に出てくる個々の技は、それだけ見るとシンプルなものばかりだ。
しかし、それが自分の書いたコードだとおろそかになってしまう。
変数に付ける名前を考えることが面倒だからだ。
そのためxみたいな安易な名前を付けてしまい、他の人からしたら死ぬほど読みにくいコードとなる。
それを避けるためには、面倒な作業でもしっかりやるべきなんだと本書は教えてくれる。
1回、1回でやることは辞書を引いて調べるくらいだから、そんなに時間がかかる作業じゃない。こういうところで妥協しない姿勢が読みやすいコードにつながるのだ。
2つ目は、未来の自分に向けて書く意識だ。
変数に適当な名前を付ける理由は、今の自分がわかっているからである。
そこで本書は、「じゃあ未来の自分はどうなんだろう」と問いかけてくる。
当然書いていたときのことなんて綺麗サッパリ忘れているだろう。
もはや他人と言っても過言ではない。
だから未来の自分が困らないように、わかりにくい表現はないか考えて書くことが大事だというわけだ。
こうしてコードを読みやすくする秘訣を見てみると、そのまま日本語の文章にも適用できることに気がつく。
たとえば辞書を調べないとわからない単語は、変数xと同じようなものだろう。これは小学生でもわかる簡単な言葉に置き換えたほうがスムーズに読める。
未来の自分に向けて書くこともそうだ。ほぼ別人になっているから、自分のことを考えるだけでも、他の人にとって読みやすく書く意識が働くわけだ。
このように、読みやすさの秘訣はコードも日本語も、文章であればどれも同じなのだということが本書から見えてくる。
ここに挙げられたテクニックが生きるのはプログラミングの世界だけではないのである。
この本が追求する読みやすさは、読む人が最速で理解できるレベルだ。そういった視点で文章の書き方を示した本は少ないんじゃないかと思う。
しかも作者が「はじめに」で、「読みやすさを扱った本の翻訳が読みにくいというのではシャレにならない」と書くだけあってとても読みやすい。
そういう意味でも貴重な本だと思う。
本書はプログラミングをやっている人は当然として、全然関係ない人でもオススメできる本だ。超読みにくいプログラムコードを読みやすくするための秘訣は、どんな文章でも通用するからだ。
「リーダブルコード」が示してくれるテクニックは、あなたの文章をスルスル読めるものにしてくれるだろう。
読みやすさに悩んでいる方は、ぜひ読んでみてください。
本記事で紹介した作品
タイトル：リーダブルコード ― より良いコードを書くためのシンプルで実践的なテクニック
著者：ダスティン・ボズウェル、トレバー・フォシェ
訳者：角 征典
出版社：オライリージャパン
＊＊＊
この記事は、天狼院書店の「リーディング＆ライティング講座」を受講した方が書いたものです。ライティング・ゼミ、もしくはリーディング＆ライティング講座にご参加いただくと記事を投稿いただき、編集部のフィードバックが得られます。チェックをし、Web天狼院書店に掲載レベルを満たしている場合は、Web天狼院書店にアップされます。
お問い合わせ
■メールでのお問い合わせ：お問い合せフォーム
■各店舗へのお問い合わせ
＊天狼院公式Facebookページでは様々な情報を配信しております。下のボックス内で「いいね！」をしていただくだけでイベント情報や記事更新の情報、Facebookページオリジナルコンテンツがご覧いただけるようになります。
■天狼院書店「東京天狼院」
〒171-0022 東京都豊島区南池袋3-24-16 2F
TEL：03-6914-3618／FAX：03-6914-0168
営業時間：
平日 12:00〜22:00／土日祝 10:00〜22:00
＊定休日：木曜日（イベント時臨時営業）
■天狼院書店「福岡天狼院」
〒810-0021 福岡県福岡市中央区今泉1-9-12 ハイツ三笠２階
TEL：092-518-7435／FAX：092-518-4149
営業時間：
平日 12:00〜22:00／土日祝 10:00〜22:00
■天狼院書店「京都天狼院」
〒605-0805 京都府京都市東山区博多町112-5
TEL：075-708-3930／FAX：075-708-3931
営業時間：10:00〜22:00
■天狼院書店「Esola池袋店 STYLE for Biz」
〒171-0021 東京都豊島区西池袋1-12-1 Esola池袋2F
営業時間：10:30〜21:30
TEL：03-6914-0167／FAX：03-6914-0168
■天狼院書店「プレイアトレ土浦店」
〒300-0035 茨城県土浦市有明町1-30 プレイアトレ土浦2F
営業時間：9:00～22:00
TEL：029-897-3325
■天狼院書店「シアターカフェ天狼院」
〒170-0013 東京都豊島区東池袋1丁目8-1 WACCA池袋 4F
営業時間：
平日 11：00〜22：00／土日祝 10：00〜22：00
電話：03−6812−1984
