Self-Documenting Code のススメ方 @lovee #iosdcrc #b
https://fortee.jp/iosdc-japan-2018/proposal/3a92b6a9-1e77-4875-a46e-83912a6b25e3
我々エンジニアは嫌いなことが二つある。一つはドキュメントを書くこと、一つは人の書いたドキュメントのないコードを読むこと。
それなら、コード自体がドキュメントになっていれば、みんなハッピーなのでは?
続きを読む
shiz(しず)@翻訳本発売中
@stzn3
細かく抽象化する - いきなり具体的な実装を考えない - 複雑な機能ほどちょっとずつ考える - 部品の責務に専念する #iosdcrc #b
2018-09-20 20:37:14
shiz(しず)@翻訳本発売中
@stzn3
暗黙の前提をなくす - いつどこで誰に呼ばれても同じ結果になるように作る - 暗黙の前提が必要である場合はassertで明示する #iosdcrc #b
2018-09-20 20:39:38
よこやす
@yokoyas000
assertはドキュメントになる(前提条件を暗黙化させない)というの、↓で知って、「いいですよね〜!」という感想 speakerdeck.com/twada/php-conf… #iosdcrc #b
2018-09-20 20:40:16
shiz(しず)@翻訳本発売中
@stzn3
コメントやドキュメントは全くいらなくなる? No。 コードはWhatとHowだけしか説明できないが、Whyも必要になる。 ドキュメントはWhyにだけ専念する #iosdcrc #b
2018-09-20 20:40:46
よこやす
@yokoyas000
実装の選択しが複数ある場合の、「なぜxxxではなくyyy にしたのか(Why)」とかもコメントあるとめっちゃいいですよね(できてない #iosdcrc #b
2018-09-20 20:42:00