「YUMEMI.apk #1」(2020年8月21日)での発表資料です。
KDoc in a nutshellokuzawatsYUMEMI.apk #12020/08/21
View Slide
自己紹介okuzawatsTwitter: okuzawatsGitHub: okuzawatsAndroidアプリエンジニア @ フラー株式会社柏の葉キャンパス/新潟We are hiring!
KDoc is 何?
KDoc is 何?ドキュメンテーションコメントを書くやつJavadocのKotlin版Markdown対応Dokkaによるドキュメントの自動生成自分はやったことないです
書き方https://kotlinlang.org/docs/reference/kotlin-doc.html
KDocを何で書くのか学習コストの低減自然言語で書けるので学習コストがあまりかからない新しくプロジェクトに入ってくる人一ヶ月後の自分設計品質の向上考慮漏れに気付くことができる設計の問題をあぶり出すことができる
KDocに何を書くのか仕様コードをどうやって使うのかなんでそうなっているのかコードを使う人がそのコードをどのように使うのかわかるように書くドキュメンテーションコメントに従った実装を行う
KDocに何を書かないのか処理内容の翻訳読めばわかることをわざわざ書く必要はない邪魔になるPrivateなメソッドに対するドキュメンテーションコメント外部に公開する物についてのみ書けば良いPrivateなメソッドは普通のコメントで良い
まとめドキュメンテーションコメントを書こう
参考文献Kotlin. (N.D.). Documenting Kotlin Code. Retrieved fromhttps://kotlinlang.org/docs/reference/kotlin-doc.html佐藤竜一. (2009). エンジニアのためのJavadoc再入門講座.翔泳社.