Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
KDoc in a nutshell
Search
okuzawats
August 21, 2020
Programming
0
260
KDoc in a nutshell
「YUMEMI.apk #1」(2020年8月21日)での発表資料です。
okuzawats
August 21, 2020
Tweet
Share
More Decks by okuzawats
See All by okuzawats
「勉強になった」で終わらせない、ストロングスタイルの勉強会
okuzawats
0
250
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
1k
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
750
何故、UseCaseは1メソッドなのか
okuzawats
3
1.3k
例外を投げるな、値を返せ
okuzawats
9
7.4k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
350
Kotlinのifを愛でる
okuzawats
0
260
Say good-bye to Kotlin Android Extensions
okuzawats
0
190
Other Decks in Programming
See All in Programming
継続的な活動で築く地方エンジニアの道
myamashii
2
350
Google's Recipe for Scaling (Web) Security – LocoMocoSec 2024
lweichselbaum
0
170
TiDB Serverless ~理想のServerless DBを考える~
soso_15315
1
160
20240706_CDKConf
takuyay0ne
0
1.2k
Trial
cairolibrary720
1
130
How to use Macrobenchmark
veronikapj
0
160
Clean Architecture by TypeScript & NestJS
ryounasso
0
150
企業向け生成AIアプリの 開発から得られた知見
takaakikakei
0
310
「2024年版 Kotlin サーバーサイドプログラミング実践開発」の補講 〜O/Rマッパー編〜
n_takehata
2
260
Folding Cheat Sheet #7
philipschwarz
PRO
0
150
Jetpack for KMP
fornewid
1
290
Findy - エンジニア向け会社紹介 / Findy Letter for Engineers
findyinc
2
81k
Featured
See All Featured
A Modern Web Designer's Workflow
chriscoyier
689
190k
Music & Morning Musume
bryan
43
5.9k
We Have a Design System, Now What?
morganepeng
46
7k
Six Lessons from altMBA
skipperchong
24
3.2k
GraphQLとの向き合い方2022年版
quramy
36
13k
The Straight Up "How To Draw Better" Workshop
denniskardys
229
130k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
13
430
RailsConf 2023
tenderlove
16
720
Product Roadmaps are Hard
iamctodd
PRO
48
10k
Infographics Made Easy
chrislema
238
18k
Facilitating Awesome Meetings
lara
46
5.8k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
248
20k
Transcript
KDoc in a nutshell okuzawats YUMEMI.apk #1 2020/08/21
自己紹介 okuzawats Twitter: okuzawats GitHub: okuzawats Androidアプリエンジニ ア @ フラー株式会社
柏の葉キャンパス/新 潟 We are hiring!
KDoc is 何?
KDoc is 何? ドキュメンテーションコメントを書くやつ JavadocのKotlin版 Markdown対応 Dokkaによるドキュメントの自動生成 自分はやったことないです
None
書き方 https://kotlinlang.org/docs/reference/kotlin-doc.html
KDocを何で書くのか 学習コストの低減 自然言語で書けるので学習コストがあまりかからない 新しくプロジェクトに入ってくる人 一ヶ月後の自分 設計品質の向上 考慮漏れに気付くことができる 設計の問題をあぶり出すことができる
KDocに何を書くのか 仕様 コードをどうやって使うのか なんでそうなっているのか コードを使う人がそのコードをどのように使うのかわかるように書く ドキュメンテーションコメントに従った実装を行う
KDocに何を書かないのか 処理内容の翻訳 読めばわかることをわざわざ書く必要はない 邪魔になる Privateなメソッドに対するドキュメンテーションコメント 外部に公開する物についてのみ書けば良い Privateなメソッドは普通のコメントで良い
まとめ ドキュメンテーションコメントを書こう
参考文献 Kotlin. (N.D.). Documenting Kotlin Code. Retrieved from https://kotlinlang.org/docs/reference/kotlin-doc.html 佐藤竜一.
(2009). エンジニアのためのJavadoc再入門講座. 翔泳社.