「読みやすいコードのガイドライン」出版記念特別企画！「読みやすいコメント・読みやすい関数とは？ CODE READABILITY LECTURE」レポート

こんにちは。
エンジニアHubを運営しておりますエン・ジャパン株式会社のデジタルプロダクト開発本部（デジプロ）で、VPoEをしております、こざわと申します。

さる10月22日に、LINE株式会社の石川宗寿さんが技術評論社より書籍「読みやすいコードのガイドライン」を上梓されました。
実はこちらの本、石川さんがコードの可読性について社内講義された[プレゼンテーションスライド]が元になっています。

当時LINEに在籍していたこざわも、それを受講したうちの一人なのですが、講義があまりによい内容だったので、「これは社内講義ではもったいないので、ぜひ本にしましょうよ」と石川さんに持ちかけて、そこから長い道のりを経て本になった経緯がございます。感無量であります。

さて、いよいよ本になりますというタイミングで、「出版に合わせてエンジニアHubでもこの本を広めるために何かできないかしら」と話をしたところ、石川さんのご厚意で、エン・ジャパンのエンジニアやインターン生向けに社内講義を組んでもらい、そのレポートを、できるだけ本を買って読みたくなるようにまとめて記事にしてみてはどうか、ということになりました。それがこちらの、書籍をプロモーションする記事となります。

講義は全八回で組まれているのですが、そのうちの二回分、「コメント」と「関数」についての回を講義してもらうことにしました。

ではそのレポートをお送りします。

• 一時間目「コメント」
  • ドキュメンテーションコメント
  • 非形式的なコメント
  • 講義後のコメント・感想
• 二時間目「関数」
  • 読みやすい関数とは
  • コマンド・クエリ分離の原則
  • 関数の流れを明確にする3つのテクニック
• 質疑応答コーナー
  • 既存コードに対してコメントを追加していくテクニック
• レクチャー後の感想
• キャンペーン情報

一時間目「コメント」