Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
読みやすいコードを書こう
Yutorin
May 16, 2022
Programming
0
650
読みやすいコードを書こう
社内のLT会で発表したスライドです。
Yutorin
May 16, 2022
Tweet
Share
More Decks by Yutorin
See All by Yutorin
新卒でサービス立ち上げから Hasuraを使って3年経った振り返り
yutorin
0
190
Other Decks in Programming
See All in Programming
Use KMM to call the API of the National Tax Agency
akkeylab
0
290
コンピュータビジョンセミナー2 / computer_vision_seminar_libSGM
fixstars
0
310
jq at the Shortcuts
cockscomb
1
380
Hasura の Relationship と権限管理
karszawa
0
140
Micro Frontends with Module Federation @MicroFrontend Summit 2023
manfredsteyer
PRO
0
400
Istio⛵️によるサービスディスカバリーの仕組み
hiroki_hasegawa
3
1.3k
SHOWROOMの分析目的を意識した伝え方・コミュニケーション
hatapu
0
230
GCPでのバッチ処理パターンを考えてみる
satohjohn
1
200
Gradle build: The time is now
nonews
1
210
Quarto Tips for Academic Presentation
nicetak
0
880
kakutanitalk2022_opening_act
shirotamaki
0
100
Git Rebase
bkuhlmann
10
1.2k
Featured
See All Featured
Raft: Consensus for Rubyists
vanstee
130
5.7k
Learning to Love Humans: Emotional Interface Design
aarron
263
38k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
13
1.1k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
318
19k
Three Pipe Problems
jasonvnalue
89
8.9k
The World Runs on Bad Software
bkeepers
PRO
59
5.7k
Art, The Web, and Tiny UX
lynnandtonic
284
18k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
152
13k
A Philosophy of Restraint
colly
193
15k
Mobile First: as difficult as doing things right
swwweet
213
7.8k
The Invisible Side of Design
smashingmag
292
48k
Typedesign – Prime Four
hannesfritz
34
1.5k
Transcript
読みやすいコードを書こう 2022/05/13 - Yutorin
2 自己紹介 Yutorin 日本語が下手です
・読みにくいコードがあると、 読みたくないし時間もかかる! 3 読みやすいコード書いてる? reference: https://qiita.com/shimataro999/items/ef6cd838d56f1fe87015
・レビューしたくなくなる ・治安が悪くなる ・ = 読みにくいコードが再生産される ・なにより次の日自分で読めない! 4 自分が読めればええやん?
いくつか抜粋して紹介します ・何が良いコードなのか? ・良くなるコードの書き方 ・コメントについて 5 そのために古事記を読め
・良いコードは1行で凄いことをすることじゃなくて、 理解しやすいかどうか ・コードは他の人が最短時間で理解出来るようにする ・そのためにコメントをつけることも大事 ・常に「このコードは理解しやすいだろうか?」と頭の中の誰かに問い 続ける 6 理解しやすいコード
・dataとかsizeとか曖昧な単語ではなく、明確で正確な単語を使おう ・data: property, description, result ・size: height, bytes, weight ・類語辞典を使おう
・get 類義語 ・get synonyms とか検索すると色々でてくる 7 名前に情報を詰め込もう
・変数に入っている情報が名前だけで読み取れないなら、追加したほう がいい ・base64化したchime_idなら encodedChimeId とか、 base64ChimeIdとか。 ・圧縮したjpg画像なら compressedImage とか compressedJpgとか
8 名前に情報を追加する
・プログラミングの時間のほとんどはコードを読む時間 ・同じようなことをするなら、同じようなものを作ろう 9 一貫性のあるコードを書こう
・コメントの目的は、書き手の意図を読み手に知らせること ・コードを書いているときの自分の考えを記録する ・他の方法がある場合、なんでこの方法を選んだか ・欠陥がある場合はFIXME、やることが残っているならTODOなど ・関数名やコード軽く眺めるだけでは得られない必要な情報 ・e.g. 7日より前のファイルは消えているためその日付以前は filter()している とか。 10 コメントをすべきこと
・コードからすぐわかることをコメントに書かない ・コメントをつけるよりも変数名を変える方がいい場合もある 11 コメントすべきではないこと
・コメント書いたほうが良いかな?と思った場合はとりあえず書こう ・後から丁寧に書き直してみたり、今まで振り返ってきたこと(改善 点を見つけてより良くする)をやってみる。 ・// ヤバいかも。重複してたら壊れちゃう。 →// 注意:この関数は重複を処理できません(難しいので) 12 とりあえず書いてみよう
・読む人の気持ちになろう ・コードを通して他の人と対話するように ・英語脳になろう ・英語が伝わってるかどうか考えることで良いコードになる・・かも? ・こだわりを持とう 13 要は...
14 読んでみてね!おわり!
15