ja ja ja ja ja ja ja ja ja en ja ja ja ja ja ja ja ja ja ja ja ka ja ja ja ja ja zh ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja en ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja zh ja ja ja ja ja ja ja ja ja ja ja ja cs ja ja ja pl ja ja ja ja ja ja ja ja ja ja en ja ja en ja ja vi ja sv eu ja en en hu ja ja en en pl ja ja jbo hbs_lat en ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja ja
札幌Ruby会議2012: 「バグの直し方」、「クリアなコードの作り方」 #sprk2012 - 2012-09-19 - ククログ
最後のセッションだった須藤の発表です。
タイトルだけ見ると「クリアなコードを作るためのテクニックを教えます!」のように見えるかもしれませんが、実際は「知ったテクニックを活かしてクリアなコードを作り、維持する方法を教えます!」という内容です。つまり、テクニックを知った後の話です。誤解される可能性があるあまりよくないタイトルでした。
内容は「We Code.」そのもの、つまり、「みんなコードを書こう!」です。札幌Ruby会議2012ではどのようにコードを書けばよいか(「How to code」)や、自分はこう書いていると言った話がたくさんあり、「自分もコードを書きたい!」という思いが強くなったのではないでしょうか。この発表は、そんなこの会議で得たテクニックや「書きたい!」という気持ちを頭や心の中で終わらせるのではなく、実際にそれを活かしてコードを書いていきましょうということを伝えようとしたものでした。「We Code.」の「Code」は「コード」という名詞ではなく、「コードを書く」という動詞なんです。「コード」について知るだけで終わるのではなく、それを活かして「コードを書く」のです。そして、この会議に参加した私達が(「We」!)「コードを書く」ことで、会議に参加していない人たちにも会議で得た知識や思いを伝えて、さらに「We」を広げていきましょう。この話を聞いてくれた人たちが、「We Code.」(「私達がコードを書く!」)という札幌Ruby会議2012で掲げられたすばらしいテーマを思い出して帰ってもらえたなら、最後のセッションの役割は果たせたのではないでしょうか。
話の大筋はスライドでもわかるでしょうが、実際の発表内容までは伝わらないでしょう。ここで補足しますが、時間に余裕のある人はUstreamの録画も参考にしてください。3:00くらいから始まります。
まず、この発表の大事な言葉である「クリアなコード」について説明します。発表中でも触れていますが、「clear」という形容詞がついた「コード」のこと2です。「clear」には「はっきりした」とか「明快な」というような意味があります。つまり、あるべきものがあるべき場所にあるべきように書かれているようなコードです。そのようなコードは、最初からそのように書かれることが当然のような自然なコードに思えます。そのようなコードはするっと読めて、すっと理解できてしまいます。そんな「自然なコード」をクリアなコードと呼んでいます。
どうしてクリアなコードを書くのか
それでは、どうしてクリアなコードを書いた方がよいのでしょうか。それはたのしく開発を続けるためです。
録画を視るとわかりますが、発表者だけではなく、札幌Ruby会議2012の参加者の多くもプログラミングが好きです。プログラミングが好きであれば、プログラムを書くことは基本的に楽しいことです。しかし、プログラミングが好きでもプログラムを書きたくないと思ってしまうときがあります。その1つが、開発が進むにつれてコードが汚くなっていくときです。汚くしてしまうのは開発仲間かもしれませんし、自分自身かもしれません。開発チームの誰か1人でも汚くしていく人がいると、楽しいはずのプログラミングが楽しくなくなってしまいます。そうなってしまっては開発を続けていけません。そうならないようにみんなでクリアなコードを書いていきたいのです。つまり「We Code.」です。もう少し言うと「We Code Clear Code.」です。みんなでクリアなコードを書きましょう。だって、そっちの方が楽しくプログラムを書けますからね。
もし、あなたがプログラミングが楽しかったことを忘れているなら、クリアなコードを書けば楽しかった頃を思い出せるかもしれません。新しい機能を追加しようとしたときに、パパッと実現できたら楽しいですよ。クリアなコードになっているとそういうことがしやすくなっているはずです。
クリアなコードの作り方とリーダブルコードの解説
クリアなコードの作り方はリーダブルコードの解説をベースにして説明しました。なお、この発表の内容はリーダブルコードの「解説」にだけ触れていて、リーダブルコードの「本文」には触れていません。なので、この発表の内容だけからはリーダブルコードに書いている内容はわかりません。リーダブルコードの「本文」と「解説」は、前述の「誤解されやすそうな発表タイトルだったね」というところと同じような関係になっています。「本文」には「テクニック」が書いていて、「解説」には「テクニックの活かし方」が書いてあります。もし、「解説」や発表内容に興味がでてきたら、リーダブルコードを購入して「本文」も読んでみてください。そこには「解説」や発表内容で言っていることを実現するために必要となる「テクニック」が書かれています。
https://amazon.co.jp/dp/9784873115658
リーダブルなコードとクリアなコード
ところで、リーダブルなコードとクリアなコードはどう違うのでしょうか3?どちらも同じところを目指しています。リーダブルなコードは「読みやすいコード」で、そのために読み手が「理解しやすい(easy to understand)」コードを書こうとします。クリアなコードは「明快なコード」で、そのようなコードは読み手がすぐに理解できます。どちらも理解しやすいコードです。
自分でもまだクリアな4答えが見つかっていませんが、「リーダブル」は読み手の方だけを意識して、「クリア」は読み手も書き手もどちらも意識しているような気がします。読み手にとっても書き手にとっても、誰が見ても自然なコードがクリアなコードと使っている気がします。いつか、クリアな答えが見つかったら報告します。
クリアなコードの作り方
クリアなコードを作るためステップは以下の3ステップです。
当たり前にする: 書く・読む
コードで伝える: 書く・読む・書く
まず、クリアなコードを書くためのテクニックを実際に使ってコードを書くことです。リーダブルコードの本文に書かれていることも使えます。ここで大事なことは自分が実際に動くことです。本を読んで満足してそれで終わり、勉強会に参加してそれで終わり、ではなく、自分が得た知識やテクニックを実践することが大事です。この段階はまだ「We Code.」ではなく「I Code.」です。
実践して自分のものになったら、今度は自分のチームに広げます。当たり前に実践するのが自分だけではなく、チームみんなが当たり前にします。クリアなコードが当たり前な文化にするのです。そのためには、自分がちゃんとクリアなコードを書き続けるだけではなく、他のメンバーが書くコードをすべて読みます。読んで、よい書き方を見つけたら参考にしますし、そうじゃないコードを見つけたら一緒に改善方法を考えます。前のステップであなたがちゃんとクリアなコードを書くということを実践していたなら、他のメンバーはあなたの話を聞いてくれるでしょう。そして、少しずつクリアなコードが当たり前な文化になっていくでしょう。「We Code Clear Code.」
しばらくすると自分のチームに新しいメンバーが入ってくることでしょう。そのときが最後のステップです。新しいメンバーはまだクリアなコードが当たり前という文化に馴染んでいません。そんな新しいメンバーにはクリアなコードはこう書くんだということをあなたがクリアなコードを書くことで伝えます。あなたはプログラマーです。コードを書くことで大事なことを伝えましょう。プログラミングが好きなあなたにはそれができるはずです。コードを書いて「We」を増やしましょう。
よいプログラマへの道を歩き出したのなら、ともにその道を歩くものだと思っています。
育ててあげるという考え方はやめることにしました。
We Code. みんなでコードを書いていきましょう。
録画の最後のところでも言っていますが、発表では「コードで伝える」と言っておきながら実際はコード無しで言葉だけで伝えていた発表でした。もし、また機会があれば言葉だけではなく、コードでも伝えたいです。
セッションではしだらさんのセッションがよかったです。いいチームだなぁと思います。
1セッション30分というのは長すぎず短すぎずちょうどよいと感じました。
ぬRubyKaigiもよかったです。まさか、札幌でRabbitの集まりを持てるとは!嬉しいことです。
セッション以外のところでうれしいことがありました。久しぶりに会った何人かに「こういうときはどうするのがいいですかねぇ。」と相談してもらえたことです。これはセッションとは関係なく、ロビーや移動中に会ったときのことです。「コードレビューすれば細かいところはよくなっていくけど、全体の設計が変な方向に向かっていることは気づきづらいですよねぇ。」、「テストなしでpull requestしちゃっていいものですかねぇ。」、「いろんなソフトウェアを開発し続けるのは大変ですよねぇ。」といったことです。話を聞いて、自分はこう思うということは伝えました。もし、少しでも何かの役に立てたのなら札幌にきてよかったなぁと思います。
しまださんについて。札幌Ruby会議はしまださんの手を離れたんだなぁと感じました。これは、しまださんが札幌Ruby会議を捨てたということではなく、次の人たちに渡せたということです。もともと札幌のみなさんはすばらしいチームで、しまださんだけが頑張っていたというわけではないのですが、しまださんが中心にも前面にもいたように感じていました。しかし、今回の札幌Ruby会議はそっと後ろからサポートするようにしまださんがいたように感じました5。毎年、しまださんの発表者紹介を楽しみにしていましたが、今年はこれがありませんでした。マルチトラックになったのでそもそも実現できないのですが、これまでとは変わったなぁと思ったことでした。
もちろん、札幌は相変わらずの心地よさでした。常に水が配布されていたり、電源を確保できたり、他の参加者と話をするスペースがあったりと会議中に困ったことはありませんでした。すばらしいチームですね6。
クリアコードからは、須藤と沖元の二人がスピーカーとして参加し、発表してきました。また、会社としてもプラチナスポンサーとして札幌Ruby会議2012を支援しました。札幌Ruby会議2012実行委員のみなさま、参加者のみなさま、ありがとうございました!!
またどこかのRuby会議で会えたらいいですね!!
日本語だけではなく英語でも情報提供をしたり、発表言語として英語も使えたり、IRC上でセッションの内容を翻訳したりしていました。セッションの内容が日本語なら英語に翻訳し、英語なら日本語に翻訳していました。 ↩
動詞ではなく形容詞として「clear」を使っています。 ↩
札幌Ruby会議2012の次の日に聞かれました。 ↩
会議中、ずっと疲れた顔をしていたのでそもそも前面に立てなかったのかもしれません。 ↩
でも、疲れていそうで心配になりました。 ↩
現在クリアコードではソフトウェア開発者を募集しています! フリーソフトウェア開発での開発の仕方をベースに、成果や知識を公開し共有しながら業務に携われます。
短期前払費用による節税
「札幌Ruby会議2012のチケットを譲るキャンペーン」当選者のレポート紹介
Apache Arrow
milter manager
ククログの記事はCC BY-SA 4.0とGFDLのデュアルライセンスで自由に利用できます。
クリアコードはプログラミングが楽しいソフトウェア開発者を1名募集しています。
クリアコードは「クリアコードをいい感じにする人」を1名募集しています。
クリアコードはフリーソフトウェア開発で培った技術力を提供しています。特にMozilla製品(Mozilla FirefoxとMozilla Thunderbird)とRubyとGroonga(全文検索)に関連した開発を得意としています。