KDoc in a nutshell - Speaker Deck

Slide 1

Slide 1 text

KDoc in a nutshell okuzawats YUMEMI.apk #1 2020/08/21

Slide 2

Slide 2 text

自己紹介 okuzawats Twitter: okuzawats GitHub: okuzawats Androidアプリエンジニア @ フラー株式会社柏の葉キャンパス／新潟 We are hiring!

Slide 3

Slide 3 text

KDoc is 何？

Slide 4

Slide 4 text

KDoc is 何？ドキュメンテーションコメントを書くやつ JavadocのKotlin版 Markdown対応 Dokkaによるドキュメントの自動生成自分はやったことないです

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

書き方 https://kotlinlang.org/docs/reference/kotlin-doc.html

Slide 7

Slide 7 text

KDocを何で書くのか学習コストの低減自然言語で書けるので学習コストがあまりかからない新しくプロジェクトに入ってくる人一ヶ月後の自分設計品質の向上考慮漏れに気付くことができる設計の問題をあぶり出すことができる

Slide 8

Slide 8 text

KDocに何を書くのか仕様コードをどうやって使うのかなんでそうなっているのかコードを使う人がそのコードをどのように使うのかわかるように書くドキュメンテーションコメントに従った実装を行う

Slide 9

Slide 9 text

KDocに何を書かないのか処理内容の翻訳読めばわかることをわざわざ書く必要はない邪魔になる Privateなメソッドに対するドキュメンテーションコメント外部に公開する物についてのみ書けば良い Privateなメソッドは普通のコメントで良い

Slide 10

Slide 10 text

まとめドキュメンテーションコメントを書こう

Slide 11

Slide 11 text

参考文献 Kotlin. (N.D.). Documenting Kotlin Code. Retrieved from https://kotlinlang.org/docs/reference/kotlin-doc.html 佐藤竜一. (2009). エンジニアのためのJavadoc再入門講座. 翔泳社.