リーダブルコード輪読会 第6章 === # ディスカッションをより豊かにするためのグランドルール - 参加者は毎回任意 - 途中参加・聞くだけでもOK! - ページ数と同時に、節のタイトルやキーワードを記入してもらえると探す手間を省けて嬉しいです - ファシリテーターや話している人は集中しがちなので、話していない人に議論内容をメモ:pencil:してもらえると嬉しいです - 気になる質問や同感するものには :+1: を末尾につけてください。 - 社外秘情報は書かないこと!!! - オープン設定で誰でも見れてしまうので # タイムテーブル | 時間 | 所要時間 | 内容 |備考 | | -------- | -------- | -------- | -------- | | 15:00 | 5-10分? | (書いてなければ)感想記入&書かれた感想・気づき・疑問をもっと掘り下げたいものを、 :+1: 付けていく | | | 15:10? | 40-45分 | 本の節ごとにディスカッション | | |15:55? | 5分 | 次回読む範囲決めてクローズ | | ## 下に感想などを書いていって下さい。どんな些細なことでもOKです。 --- # 序章、6.1 コメントを簡潔にしておく ## 感想・気づき - p.72 「正確に書くべきだ(できるだけ明確で詳細に)」の後に、「簡潔なものでなければいけない」と続く - 詳細と簡潔は両立する? ## 疑問 - --- # 6.2 あいまいな代名詞を避ける ## 感想・気づき - p.73 「それ」を明確にするすると、「データが十分に小さければ、キャッシュに入れる。」のように、「それ」を省いても伝わる内容になって消せることが多いと感じる - :memo:プレゼンやメールの書き方にも通じる話 - :memo:前置きの長さなども理解しやすさに影響が出る > 日本人の傾向 - :memo:コンテキストの統一を意識、コンテキストを落とす/あげるとどうなるか意識すると良いかも ## 疑問 - --- # 6.3 歯切れの悪い文章を磨く ## 感想・気づき - コメントは直接的な表現をすることが大事 - :memo:断定的な文書で書く - :memo:否定形、二重否定を使わない - :memo:頭の中の思考の出し方 - 文書にしながら(違和感があっても)書いて、後から直す - 箇条書きで洗い出してから、文書を構築 - 箇条書きの粒度を意識 > 優先度で残すべきものを考える ## 疑問 - --- # 6.4 関数の動作を正確に記述する ## 感想・気づき - 日本語に直した結果、かえって分かりづらくなってしまったパターン - 基本的には直接的な方が良いと感じる。読むのも大抵PGなので... ## 疑問 - --- # 6.5 入出力のコーナーケースを実例に使う ## 感想・気づき - UnitTestがあれば、そちらで表現したいところ:+1: - 私は実例をコメントすることはないけど他の人はどうだろう? ## 疑問 - --- # 6.6 コードの意図を書く ## 感想・気づき - ここの例は、メソッド内のユースケースの説明なので、6.5まで説明してきたメソッドの説明と毛色が違う点に注意 - :memo:コードの説明になると、コードと一致しているかの視点で見てしまう ## 疑問 - --- # 6.7 「名前付き引数」コメント ## 感想・気づき - 最近の言語は名前付き引数使えることが多いので、あまり考える必要なさそう - インラインコメントも昔の開発の名残? - 関数名(_ 引数: 型)のような名前なし引数の方が楽だと感じてしまうので、気をつけたい ## 疑問 - --- # 6.8 情報密度の高い言葉を使う ## 感想・気づき - 無意識に使ってることが多いと感じた - 実際はチームの熟練度にも左右されるかも? - 情報密度の高い言葉を使えるためには学習が必要だと感じた - :memo: この例からは読み取れるか怪しい、かえって情報が不足しているように感じる - 経験を積んでという前提があるとしても疑問 - :memo: この言い換えは難しいし、実践してる人は少ない印象 ## 疑問 - --- # 6.9 まとめ ## 感想・気づき - ユースケースの説明は意図など人間の思考近いコメント、メソッドの説明は直接的な内容をコメントと、無意識で使い分けしてるのを再認識できた ## 疑問 - --- # 時間に余裕あれば ## 輪読会進め方について意見・要望など - anatakaの疑問解決、意見発表の場みたいな状態になってる気もするけどこのままで良いのか? - 実は聞きたいけど、遠慮してないかなど気になり - なるほど、、、と納得してしまうので疑問があまり出ないです - anamiz以外の人からも事例あれば聞いてみたい
×
Sign in
Email
Password
Forgot password
or
By clicking below, you agree to our
terms of service
.
Sign in via Facebook
Sign in via Twitter
Sign in via GitHub
Sign in via Dropbox
Sign in with Wallet
Wallet (
)
Connect another wallet
New to HackMD?
Sign up