コードチェンジ Powered by Rabbit 2.1.7
コードチェンジ
須藤功平
株式会社クリアコード
実践リーダブルコード
2015-03-06
コードチェンジ Powered by Rabbit 2.1.7
目的
リーダブルな
コードを探す
コードチェンジ Powered by Rabbit 2.1.7
おさらい:今日の体験内容
「まず自分が読み始める」✓
「リーダブルコードを探す」
(読みにくいコードは今は置いておく)
✓
「リーダブルの基準を共有」✓
コードチェンジ Powered by Rabbit 2.1.7
ポイント
リーダブルじゃないコードより
リーダブルなコード
コードチェンジ Powered by Rabbit 2.1.7
リーダブルじゃないコード
見つけやすい
異質✓
読んでいると詰まる✓
✓
今日のチャレンジ
気をとられない✓
✓
コードチェンジ Powered by Rabbit 2.1.7
リーダブルなコード
見つけにくい
まわりのコードになじんでいるから✓
すーっと理解できてひっかからない✓
✓
今日のチャレンジ
意識して見つけよう!✓
✓
コードチェンジ Powered by Rabbit 2.1.7
やること
他の人のリポジトリーをfork✓
どこまで進んでいるかを把握
リーダブルコードを探す✓
✓
開発を継続(改良)
リーダブルコードを探す✓
✓
コードチェンジ Powered by Rabbit 2.1.7
リーダブルコードを発見!
メモに残す✓
既存のmemo.mdに追記してpush✓
↓を含める
実際のコードのURL✓
リーダブルな理由✓
見つけたきっかけ✓
✓
コードチェンジ Powered by Rabbit 2.1.7
メモ例
## 統一されたスタイル ← リーダブルな書き方の名前
URL: https://github.com/kou/.../commit/eb02be
コード:
@@ -64,7 +64,7 @@ void add_recipe_to_RecipeList(...) {
void open_RecipeList(RecipeList *list, char *path) {
FILE *fp;
/* ファイルを開く */
- if ((fp = fopen(path , "r")) == NULL){
+ if ((fp = fopen(path , "r")) == NULL) {
fprintf (stderr, "ファイルが開けませんn");
fclose(fp);
exit(EXIT_FAILURE);
理由:
ファイル内でスタイルを統一しているので読みやすくなっている。
コードチェンジ Powered by Rabbit 2.1.7
リーダブルコードとは
読む人基準
「読む人」が 読みやすいなら
リーダブル
✓
✓
読む人(=自分)基準でよい
自分はどんなコードが
リーダブルだと思うのか
言語化してみよう
✓
凝った書き方を見つけるのは
目的ではない!
✓
✓

実践リーダブルコードのコードチェンジ

  • 1.
    コードチェンジ Powered byRabbit 2.1.7 コードチェンジ 須藤功平 株式会社クリアコード 実践リーダブルコード 2015-03-06
  • 2.
    コードチェンジ Powered byRabbit 2.1.7 目的 リーダブルな コードを探す
  • 3.
    コードチェンジ Powered byRabbit 2.1.7 おさらい:今日の体験内容 「まず自分が読み始める」✓ 「リーダブルコードを探す」 (読みにくいコードは今は置いておく) ✓ 「リーダブルの基準を共有」✓
  • 4.
    コードチェンジ Powered byRabbit 2.1.7 ポイント リーダブルじゃないコードより リーダブルなコード
  • 5.
    コードチェンジ Powered byRabbit 2.1.7 リーダブルじゃないコード 見つけやすい 異質✓ 読んでいると詰まる✓ ✓ 今日のチャレンジ 気をとられない✓ ✓
  • 6.
    コードチェンジ Powered byRabbit 2.1.7 リーダブルなコード 見つけにくい まわりのコードになじんでいるから✓ すーっと理解できてひっかからない✓ ✓ 今日のチャレンジ 意識して見つけよう!✓ ✓
  • 7.
    コードチェンジ Powered byRabbit 2.1.7 やること 他の人のリポジトリーをfork✓ どこまで進んでいるかを把握 リーダブルコードを探す✓ ✓ 開発を継続(改良) リーダブルコードを探す✓ ✓
  • 8.
    コードチェンジ Powered byRabbit 2.1.7 リーダブルコードを発見! メモに残す✓ 既存のmemo.mdに追記してpush✓ ↓を含める 実際のコードのURL✓ リーダブルな理由✓ 見つけたきっかけ✓ ✓
  • 9.
    コードチェンジ Powered byRabbit 2.1.7 メモ例 ## 統一されたスタイル ← リーダブルな書き方の名前 URL: https://github.com/kou/.../commit/eb02be コード: @@ -64,7 +64,7 @@ void add_recipe_to_RecipeList(...) { void open_RecipeList(RecipeList *list, char *path) { FILE *fp; /* ファイルを開く */ - if ((fp = fopen(path , "r")) == NULL){ + if ((fp = fopen(path , "r")) == NULL) { fprintf (stderr, "ファイルが開けませんn"); fclose(fp); exit(EXIT_FAILURE); 理由: ファイル内でスタイルを統一しているので読みやすくなっている。
  • 10.
    コードチェンジ Powered byRabbit 2.1.7 リーダブルコードとは 読む人基準 「読む人」が 読みやすいなら リーダブル ✓ ✓ 読む人(=自分)基準でよい 自分はどんなコードが リーダブルだと思うのか 言語化してみよう ✓ 凝った書き方を見つけるのは 目的ではない! ✓ ✓