= まとめと次のステップ : author 結城洋志 : institution 株式会社クリアコード : content-source 実践リーダブルコード : date 2022-11-02 : allotted-time 20m : theme clear-code = おさらい * 講座の目的？ * リーダブルコードの必要性？ * 講座でやったこと？ = 講座の目的 * 自分の開発チームに * ((*リーダブルなコードが\n 当たり前な文化の作り方*))を * 持ち帰る = リーダブルコードの必要性 * 既存のコードを読んで\n ((*素早く内容を把握する*))ため * 既存のコードに\n ((*手を加える・続きを書く*))ときの\n 効率を落とさないため = 変更コストと開発速度 # image # src = images/readable-code-reasonability.svg # relative_width = 90 == プロパティー : enable-title-on-image false = 文化の作り方の流れ（1） * まず自分が\n ((*コードを読む人*))になる * よいコードを共有し、\n リーダブルコードの基準を作る * 「読む人」が\n 読みやすいなら\n リーダブル = 文化の作り方の流れ（2） * ((*コードを読みあうチーム*))になる * 基準の育て方 * 各メンバーがコードを読む * リーダブルだと思ったコードを共有 * チームとしてリーダブルかを判断 * →チームの基準に加わる = 基準の育て方 * コードを読む文化を作る * まず自分が読み始める * リーダブルなコードを探す * 見つけたリーダブルなコードを\n 他のメンバーに伝える * →コードが読まれるという自覚が\n チームに浸透 (('tag:center')) (('note:今日やったのはここまで')) = コードを読むきっかけを増やす！ (('tag:center')) (('note:次のステップの例')) * ((*コミット単位*))で読む * ((*スタックトレース*))を\n 手がかりに読む * ((*出力されるメッセージ*))を\n 手がかりに読む ((' ')) = 例1：コミット単位で読む commit 4d516212f14ddcf04a8ead386104dab1d37ab8f4 Author: YUKI "Piro" Hiroshi Date: Tue Oct 4 14:12:49 2022 +0900 Support backquote diff --git a/common/placeholder-parser.js b/common/placeholder-parser.js index fe6d4df..d9c82ee 100644 --- a/common/placeholder-parser.js +++ b/common/placeholder-parser.js @@ -31,14 +32,17 @@ export function process(input, processor, processedInput... if (escaped) { if ((inDoubleQuoteString && character == '"') || - (inSingleQuoteString && character == "'")) { + (inSingleQuoteString && character == "'") || + (inBackQuoteString && character == '`')) { if (inArgsPart) rawArgs += '\\'; } = コミットの読み方 * コード全体ではなく差分を読む * コードの中身・設計の仕方ではなく\n コードの書き方・開発の仕方に注目する * ((*文脈なしでも読みやすい*))\n ((*→コードがリーダブルな証拠*)) = コミット単位で読む負担を減らす * pull型よりpush型にする\n (('note:（メール、チャットへの自動投稿など）')) * 読むのに取りかかるコストが下がる * 流し読む（負担が多いと続かない） * 問題探し視点では読まない\n (('note:（必要ならコードレビューを実施）')) = コードを読むと気付きが増える * 「詰まらずに読めるなあ」 * 「詳しくは分からないけど\n 　流れを追いやすいなあ」 * 「コミットの差分から\n 　趣旨を読み取りやすいなあ」 * ((*→コードやコミットが*))\n 　((*リーダブルな証拠*)) = コミット単位で読むのが難しい場合 * 文脈がないと読むのが辛い * 知らない言語、\n 知らないプロジェクトだと\n 目が滑る →文脈を伴った読み方をしてみる = 例2：スタックトレース SyntaxError: /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/parser/ext/enscript.rb:120: syntax error, unexpected keyword_end, expecting end-of-input /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/parser/rd/ext/block-verbatim.rb:25:in `' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/parser/rd/rd2rabbit-lib.rb:9:in `' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/parser/rd.rb:12:in `' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:30:in `require_safe' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:48:in `block (2 levels) in require_files_under_directory_in_load_path' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:43:in `glob' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:43:in `block in require_files_under_directory_in_load_path' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:41:in `each' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/utils.rb:41:in `require_files_under_directory_in_load_path' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/parser.rb:4:in `' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/canvas.rb:8:in `' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/command/rabbit.rb:48:in `run' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/command/rabbit.rb:29:in `run' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/task/slide.rb:238:in `rabbit' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib/rabbit/task/slide.rb:100:in `block in define_run_task' /var/lib/gems/2.5.0/gems/rake-12.3.2/exe/rake:27:in `' Tasks: TOP => default => run (See full trace by running task with --trace) = 恐れることはない SyntaxError: /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib /rabbit/parser/ext/enscript.rb:120: syntax error, unexpected keyword_end, expecting end-of-input /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib /rabbit/utils.rb:48: in `block (2 levels) in require_files_under_directory_in_load_path' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib /rabbit/utils.rb:43:in `glob' /var/lib/gems/2.5.0/gems/rabbit-2.2.1/lib /rabbit/utils.rb:43: in `block in require_files_under_directory_in_load_path' どこを見ればいいか書いてあるだけ = エラーに遭遇した時に深掘りしてみる * どういう経緯でエラーに\n なったかが分かる * 回避方法や解決方法が分かる\n (('note:（当てずっぽうで色々試さなくて済む）')) * ((*経緯を辿りやすい*))\n ((*→コードがリーダブルな証拠*)) = 例3：画面に出ているメッセージ Firefox のファイルを他のアプリケーションが使用しているため、 ブックマークと履歴のシステムが無効化されます。この問題は セキュリティソフトが原因で生じることがあります。 # image # src = images/error-message.png # relative_width = 90 == プロパティー : enable-title-on-image false = ソースコード内を検索する https://searchfox.org/l10n /source/ja/browser/chrome/browser/places/places.properties ... # LOCALIZATION NOTE (lockPrompt.text) # %S will be replaced with the application name. lockPrompt.text =%S のファイルを他のアプリケーションが 使用しているため、... ... = 変数名や関数名などを辿っていく https://searchfox.org/mozilla-central /source/browser/components/BrowserGlue.jsm /** * Show the notificationBox for a locked places database. */ _showPlacesLockedNotificationBox: function BG__showPlacesLockedNotificationBox() { ... var text = placesBundle.formatStringFromName("lockPrompt.text", [ applicationName, ]); ... = 目に見えるものを手がかりに深掘りしてみる * どういう経緯で表示\n されているかが分かる * 回避方法や解決方法が分かる\n (('note:（当てずっぽうで色々試さなくて済む）')) * ((*経緯を辿りやすい*))\n ((*→コードがリーダブルな証拠*)) = OSSのコードを読んで学ぶ * OSSのコードは\n リーダブルになるように\n 気をつけて書かれることが多い * × すごい技術力があるから\n 　　リーダブルに書けている * ○ 並の技術力なので\n 　　リーダブルにしないと\n 　　やってられない = 共有の仕方の例 * リーダブルコードの共有方法 * Wikiに書く（全チームで有効） * コードで伝える（上級チーム向け） = Wikiに書いて共有する * Wikiもdiffを通知するように\n するとなお良い\n (('note:（RedmineとGitHub用はツールあり）')) * 後で参照できる * 更新もできる\n (('note:（リーダブルコードの基準は変わることもある！）')) = 実際のコードで共有する * 上級チーム向け\n (('note:（チームにコードを読む文化が根付いた後）')) * リーダブルコードを\n 真似てコミット * →他の人：「またこの書き方だ」 * →真似する人増加→チームが合意 * →チームが合意→Wikiにまとめる = コードを読む文化 * 新人にも真っ先に\n その文化に馴染んでもらう * 新人のスムーズな受け入れに有用 * 人の入れ替えがチームのリーダブル基準の見直しの機会になる = 新人のスムーズな受け入れに有用 (('tag:center')) 開発を通じて↓を共有できる\n * チームが大事にしていること * チームのリーダブル基準 * チームの開発スタイル (('note:（ただし、上級チームになっていればだが。）')) = 新人のスムーズな受け入れに有用 (('tag:center')) チームが大事にしていることが\n 開発を通じて共有される\n ↓ * 新人に手取り足取り教えずに済む * 開発速度低下を抑えられる = リーダブル基準の見直しの機会に (('tag:center')) チームが大事にしていることが\n 開発を通じて共有される\n ↓ * 「もっとこっちの方が\n リーダブルでは？」 * チームのリーダブル基準の\n 見直しのよい機会 = これからやること * この講座をチームでもやる * 資料はすべて再利用可能 * 自分がコードを読み始める * 自分が変更するコードの周辺から\n リーダブルコードを探す * 見つけたリーダブルなコードを\n 他のメンバーに伝える = 読みにくいコードに打ち克つ！ * × 読むコストが勿体ないから\n 　　読むのをやめる * △ 「読みにくい」と指摘する * ○ 読みやすいコードにしていく * ○ 読みやすくする知見を\n 　　共有していく = サポート * 今日の資料はすべて再利用可能\n (('note:https://github.com/clear-code/readable-code-workshop/tree/master/20221102a'))\n (('note:（ https://slide.rabbit-shocker.org/authors/Piro/ ）')) * 迷ったら読み返せる = クリアコード * クリアなコードが大切 * クリア == clear == 意図が明確 * クリアなコードはリーダブルコード (('tag:center')) みなさんのコーディングライフで\n リーダブルコードが当たり前に\n なることを応援します！