リーダブルなコードを書く習慣の身に付け方・実践の仕方 - 2021-09-22 - ククログ

結城です。 2021年9月13日から14日にかけて、東京都立大学の大学院生向け特別講義として「リーダブルコード演習」を実施しました。 演習の内容は、当社でこれまでにも行ってきているリーダブルコードワークショップを、プログラミング経験が比較的浅い・プログラミングの量がまだそれほど多くない方向けに調整した内容としました。 この記事では、実施した演習の概要と、今回意識した点を紹介します。 本文が長いため、目次を用意してみました。 発端 演習の構成 座学パート リーダブルなコードを書く意義について リーダブルコードを実践するためにまず取り組むべきこと 実際の現場での「コードがリーダブルでなくなってしまった」「リーダブルになるよう改めた」実践例 最初の実装 リーダブルでなくなった実装 リーダブルさを取り戻すための改修 コードがリーダブルでなくなっていってしまう要因 壊すのが怖くて、見て見ぬフリ 恐怖

[endo_5501]

“「既存のコードを書き直すのが怖かったから」” それな。勇気が無い、というかそれを補強する自信がない。でもそのまま進めると後で地獄を見る

[kazkaz03]

リーダブルコードについて書くと定期的に「お前の文章の方がリーダブルでない」という揚げ足取りが湧くから、書く人が可哀想

[tsz]

「前提知識を共有していない読み手の気持ちになり、まっさらな頭でコードを読み返す」読みやすいものができたと思った時にはいつも「ワケわからん」といわれる。どうも独りよがりな読みやすさっぽい。

[aceraceae]

いいんだけどローカルなループ変数までわざわざ index なんて長い名前にするのは一行が長くなって可読性を下げるんで i とかでも意味不明にはならないと思うよ。丁寧な命名のせいで逆に一覧性が低下することもある。

[Nobkz]

「リーダブルなコードを書くための記事」自体が、リーダブルでない批判はくだらねぇなと。「読みやすい文章を書く方法」をわざわざ分かりやすく書かなければならないと言う決まりは無い。揚げ足取りでしか無い。

[hase0510]

id:hayato892 変数名に型の略称を含める手法（ハンガリアン記法）は2005年にJoel Spolskyのエッセイが出たあたりから一気に廃れた記憶です。 https://bit.ly/3o7Q7CZ

[jintrick]

この記事、リーダブルじゃない / 揚げ足取りでも言いがかりでもなく、意味のある事実。難読コード書く人はこんなん読まんから。発端とか要らん

[t-ueno]

「マメにコードを読み返して、リーダブルでなくなってきた兆候に気付いたら早急に書き直す」　→　企業でプログラミングしてるとこれができない。試験通過して次工程に進んだら（orリリース済み）、勝手に触れない。

[otihateten3510]

リーダブルコードの話になると厳密な美しさを求める人が出始めるがこの記事はそれだと思う。厳密に美しい、ある種数学的な記述はリーダブルではないことが結構ある。人によって読みやすさが違うから仕方ないが。

[CardamomPowder]

結局、設計やリファクタのコストをどれだけ許容できるか？（コストを下げる技術力がどれだけあるか？）みたいな話で、綺麗なコードってコードじゃなくてその上のレイヤの話だと思う

[indication]

何をしたいのか、何ができなくてこの形になったのかを丁寧に書きたい。mozillaのuser_agent定数のように。

[kiyo_hiko]

“リーダブルさ” 可読性でもReadabilityでもなくリーダブルさ。

[hara_boon]

確かに長えけど、冗長とは思わなかったな。発端、内容、講義の振り返り、と盛りだくさんなので、誰目線なの？と思ったけど単なるまとめぐらいでしかないような気がするし。件の本読まないとなとは思ってる、、

[yamami78651]

大学でこういうのやってもらえるのは幸せだね。別で、読みやすいのは嬉しいけど、読解力鍛えるんに、まぁまぁ手強いコード読むのも嫌いじゃない。秘伝のタレ化しているコードの解読を行ったときの達成感とかね

[nabinno]

読みづらさはレポートと同じで構成・コード・形式の3要素で判断する。大抵はコードで完結することはなく歴史的経緯で構成がつぎはぎだらけになっている上、その経緯が属人化していることに原因がある。

[queeuq]

個人的には可読性ってダサい素直な書き方をすることだと思ってる。

[ppoky]

最高です。この質の記事がタダで読めることに感謝。

[ys0000]

題材がExcel操作という面倒なコードなんで読むのを止めた。最後のbuild-xlsx-3.pyでclass化して多分見通しは良くなってるけども結構elif 使ってるね。switch的なものはdictionary 等で置き換えるなど工夫の余地があると思う。

[amebacore]

リーダブルコードにするには当たり前だがコードを書き直す時間を確保していないとできない。現実はまずそこからなんだよな。どっかの記事にも書いてたけど、まずPDCAを回せる余裕がいる。PDDDDDDD...だとだめ。

[piro77]

テストがない既存コードを書き直すのは大変だよな(´・ω・｀)

[pascal256]

後で読む

[tomono-blog]

理解しがたい話の例としては、アレがアレしてアレだから、アレやねん。みたいな自分しかわかってないやつ。

[hiroomi]

テスト書く、バージョン管理、静的解析は、お手軽に試す環境作りと、習慣化。と、作業見積は目的に到達して整理整頓まで盛り込むと。

[hayato892]

ロートルなんでトレンドが全くわからないのだが、今は変数の命名規則に型は入れないのかな？

[sezemi]

“汚したときにすぐに掃除すれば、サッと拭き取るだけで綺麗になります。 コードの「よくない兆候」も同じ” 自戒

[wrss]

あとで読み返したい

[Nyoho]

受けたい