clear-code/readable-code-workshop

リーダブルコードワークショップ用資料

リーダブルコードワークショップ

このリポジトリーは、クリアコードが実施する「日々リーダブルコードを書くことを当たり前にする」ワークショップ用の資料を管理するリポジトリーです。

このワークショップはリーダブルコードの解説を書いた須藤が設計しました。

対象者

• リーダブルコードを読んで理解はしたが実践はできていない開発者
• リーダブルコードの解説に書いている次のことを実践したい開発チーム
  • 自分が日々リーダブルなコードを書くプログラマーになりたい方
  • 自分のチームがリーダブルなコードを書くチームになりたい方
  • 自分のチームに新しいメンバーが入ってきたら自分たちが書くリーダブルなコードでリーダブルなコードの書き方を伝えるようになりたい方

対象プログラミング言語

ワークショップでは実際にコードを読み書きしながらリーダブルコードを書くことを当たり前にしていきます。リーダブルコードは言語に依存しない概念なので、普段使っているプログラミング言語を使って参加できます。例えば、次のプログラミング言語で参加できます。このリストに載っていないプログラミング言語で参加したい場合はお問い合わせください。

• Ruby
• Python
• Perl
• PHP
• C
• C++
• JavaScript
• Java
• Objective-C

内容

ワークショップの内容は次の資料を参考にしてください。「日々リーダブルコードを書くことを当たり前にする」という目的を実現するための内容になっています。

• シナリオ
• 課題

このリポジトリーにある資料はCC-BY-SA-4.0（著作者：株式会社クリアコード）のライセンスで自由に利用できます。ワークショップに参加した人が周囲の人たちにさらに広めるために使うこともできます。

開催予定

• なし

過去の開催

• 2022年08月04日（木）～05日（金）：東京都立大学 リーダブルコード演習
• 2021年09月13日（月）～14日（火）：東京都立大学 リーダブルコード演習
• 2015年06月24日（水）：実践リーダブルコード：アジャイルアカデミー
• 2015年06月06日（土）：SEゼミ2015 - リーダブルコード勉強会
• 2015年03月06日（金）：実践リーダブルコード：アジャイルアカデミー
• 2014年07月06日（日）：SEゼミ - リーダブルコード勉強会（2回目）
• 2014年06月22日（日）：SEゼミ - リーダブルコード勉強会（1回目）

問い合わせ先

このワークショップはコードリーダー育成支援サービスの一環として実施しています。リーダブルコードを当たり前にしたい開発会社の社内研修としても実施しています。開催依頼・ご質問などはお問い合わせフォームからお問い合わせください。

readable-code-workshop's Issues

実践リーダブルコード 2015-03-06

2015年3月6日（金）開催の実践リーダブルコードで情報共有に使うためのissueです。

次の用途に使います。

• 参加者のリポジトリーのURLの共有
• 参加者からの質問受け付け窓口

クラスメンバー変数であることを明示する

2015-12-22: リーダブルコードメモ

「自分が書いたリーダブルコード」と「自分が見つけたリーダブルコード」をここにメモしていっていてください。目的は「リーダブルコードを見つける練習」です。単に「書く」「見つける」だけでなく、「メモとしてまとめる」ことまですることで「再利用可能な状態」（＝他の人に説明できる、他の場面で同じ書き方を適用できる）まで自分の中で整理されることを期待しています。

1つのリーダブルコードにつき1つのコメントにしてください。

各コメントには次の内容を含めてください。

• サマリー（あるいはタイトルあるいは一言説明）
• 実際のコード
• どうしてリーダブルだと考えたかの説明
• 「見つけた」場合のみ：見つけた経緯（あるいはきっかけ）

コメントに書くときは次のテンプレートを使ってください。

### サマリー

（ここにサマリーを書く）

### 実際のコード

```java
（ここに実際のコードを書く）
```

### どうしてリーダブルだと考えたかの説明

（ここに説明を書く）

### 見つけた経緯

（「見つけた」場合のみ。ここに見つけた経緯を書く。）

以下は具体例です。

---

サマリー

自己記述的定数名

実際のコード

https://github.com/doraemon13x/doraemon13x-sezemi-2014-readable-code-2/blob/master/mission3.c#L9

exit(EXIT_FAILURE); /* エラーの場合は異常終了する */

どうしてリーダブルだと考えたかの説明

コマンドの終了ステータスは、正常終了するときは0、異常終了するときは0以外の値を返すのが通例です。そのため、このコードは次のようにしても通例通りの動きになります。

exit(1);

ただ、動くのは動きますが、EXIT_FAILUREという名前を使っている方が「失敗して終了するんだな」というのがわかりやすいのでリーダブルだと考えました。

なお、EXIT_SUCCESSというのもあるので、同様の理由で正常終了するときはそれを使うのがよいと思います。

見つけた経緯

ちゃんとエラー処理をしていて立派だなぁと思って読み進めたら異常終了することがわかりやすいコードだと気づきました。

---

今後の課題メモ

気付いたことをメモしていく。

• PCを貸し出すときは、基本的な環境を構築しておく
• git client も確認しておく。特にWindows
• 言語ごとに一般的な開発環境についてまとめておく

「そのレシピ情報をデータとして別のファイルに保存し」という箇所で別のファイルに出力するという意味に取ってしまう人がいた。

JavaとJavaScriptのチェンジ候補

Java

• https://github.com/ayemos/ayemos-sezemi-2015-readable-code
• https://github.com/shin-taro/shin-taro-sezemi-2015-readable-code
• https://github.com/yu1ro/yu1ro-sezemi-2015-readable-code

サーバーサイドJavaScript(念のため)

• https://github.com/qzwpq/qzwpq-sezemi-2015-readable-code

クライアントサイドJavaScriptは適切なものが存在しないので作らないといけない。

GroupB のまとめ用

ここに、memo.mdへのURLを貼ってくださいまし。

2015-12-22: コミットメール用メーリングリストに登録

次の内容のEメールを送信する。

To: [email protected]
Cc: [email protected]
Subject: Subscribe

subscribe

#{自分のGitHubアカウント名}

1年間投稿がないと勝手に消滅するメーリングリストなので、明示的に退会処理をする必要がありません。

明示的に退会するときは次の内容のEメールを送信します。注意点は「HTMLメール」ではなく「テキストメール」にすることです。

To: [email protected]
Subject: Unsubscribe

unsubscribe

2015-08-11: コミットメール用メーリングリストに登録

次の内容のEメールを送信する。

To: [email protected]
Cc: [email protected]
Subject: Subscribe

subscribe

#{自分のGitHubアカウント名}

2015-08-11: リーダブルコードメモ

「自分が書いたリーダブルコード」と「自分が見つけたリーダブルコード」をここにメモしていっていてください。目的は「リーダブルコードを見つける練習」です。単に「書く」「見つける」だけでなく、「メモとしてまとめる」ことまですることで「再利用可能な状態」（＝他の人に説明できる、他の場面で同じ書き方を適用できる）まで自分の中で整理されることを期待しています。

1つのリーダブルコードにつき1つのコメントにしてください。

各コメントには次の内容を含めてください。

• サマリー（あるいはタイトルあるいは一言説明）
• 実際のコード
• どうしてリーダブルだと考えたかの説明
• 「見つけた」場合のみ：見つけた経緯（あるいはきっかけ）

コメントに書くときは次のテンプレートを使ってください。

### サマリー

（ここにサマリーを書く）

### 実際のコード

```ruby
（ここに実際のコードを書く）
```

### どうしてリーダブルだと考えたかの説明

（ここに説明を書く）

### 見つけた経緯

（「見つけた」場合のみ。ここに見つけた経緯を書く。）

以下は具体例です。

---

サマリー

自己記述的定数名

実際のコード

https://github.com/doraemon13x/doraemon13x-sezemi-2014-readable-code-2/blob/master/mission3.c#L9

exit(EXIT_FAILURE); /* エラーの場合は異常終了する */

どうしてリーダブルだと考えたかの説明

コマンドの終了ステータスは、正常終了するときは0、異常終了するときは0以外の値を返すのが通例です。そのため、このコードは次のようにしても通例通りの動きになります。

exit(1);

ただ、動くのは動きますが、EXIT_FAILUREという名前を使っている方が「失敗して終了するんだな」というのがわかりやすいのでリーダブルだと考えました。

なお、EXIT_SUCCESSというのもあるので、同様の理由で正常終了するときはそれを使うのがよいと思います。

見つけた経緯

ちゃんとエラー処理をしていて立派だなぁと思って読み進めたら異常終了することがわかりやすいコードだと気づきました。

---