読みやすいコードを書くために - Qiita

この記事は、社内向けに書いた資料を公開の許可を得て加筆修正したものです。 記事中の具体例やサンプルコードはJavaScript/TypeScriptで書かれていますが、内容自体は言語にかかわらず使えます。 同僚の @shisama にも手伝っていただきました。 はじめに 命名について 条件式について 関数について 変数・定数について コメントについて 2020/11/02 ついに完結！ はじめに 読みやすいコードは、コメントがなくても文章を読むように理解できます。 逆に、読みにくいコードはコメントがあってもさっぱり意味がわかりません。 文章を読むように理解できるコードを書くために普段気をつけていることや、コードレビューの際に重点的に見ているところをまとめました。 普段から読みやすいコードを心がけている方にとっては何も目新しい物はなく、当たり前に意識しているであろうことばかりです。 特にプロ

[wwolf]

細かいけど、findUsersByNameだとUserクラスのインスタンスのリストが返ってくる事を期待しちゃう

[wordi]

型を名前に付けるの冗長やんと思ったらJavaScriptの事だった/getはC++だとO(1)であるものに限定されてたりする

[grandcolline]

わかりやすい。勉強になる。

[koogawa]

getXXX は積極的に避けている

[igrep]

isLeapYearみたいな関数を書くとき、遅延評価があるとearly returnを使ったバージョンにする必要がなくなるので楽なんだよな。isDividedBy400みたいな変数で分割するだけでよくなる。returnに渡すのがtrueかfalseかで迷う余地もない

[nkgr]

個人的には引数の命名で検索条件を絞れるならメソッド名はByIdとかは省略してもいいかなーと思うけど。 findUser(userId:Int)やfindUser(email:String)とか。まあオーバーロードだから引数の型一緒の時どうする問題あるけど。

[yasu-log]

【B!】読みやすいコードを書くために - Qiita

[tech0403]

fetch,find,searchの説明は違和感。何より、howよりwhatと言うのであれば、これら全てfindでいい事になる。returnの多用もfindbugsで警告出たりする。読みやすいと謳うからツッコミを入れたくなるんであって一番重要なのは統一感