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
420
KDoc in a nutshell
「YUMEMI.apk #1」(2020年8月21日)での発表資料です。
okuzawats
August 21, 2020
Tweet
Share
More Decks by okuzawats
See All by okuzawats
Androidアプリのモジュール分割における:x:commonを考える
okuzawats
1
390
「Chatwork」Android版アプリを 支える単体テストの現在
okuzawats
0
330
カンファレンス参加をいかに正当化するか
okuzawats
0
290
「勉強になった」で終わらせない、ストロングスタイルの勉強会
okuzawats
0
390
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
1.3k
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
1.1k
何故、UseCaseは1メソッドなのか
okuzawats
3
2k
例外を投げるな、値を返せ
okuzawats
9
8k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
600
Other Decks in Programming
See All in Programming
Infer入門
riru
4
1.5k
Langfuseと歩む生成AI活用推進
licux
3
290
The State of Fluid (2025)
s2b
0
180
実践 Dev Containers × Claude Code
touyu
1
220
技術的負債で信頼性が限界だったWordPress運用をShifterで完全復活させた話
rvirus0817
1
1.9k
あまり知られていない MCP 仕様たち / MCP specifications that aren’t widely known
ktr_0731
0
280
Microsoft Orleans, Daprのアクターモデルを使い効率的に開発、デプロイを行うためのSekibanの試行錯誤 / Sekiban: Exploring Efficient Development and Deployment with Microsoft Orleans and Dapr Actor Models
tomohisa
0
190
[FEConf 2025] 모노레포 절망편, 14개 레포로 부활하기까지 걸린 1년
mmmaxkim
0
810
オープンセミナー2025@広島「君はどこで動かすか?」アンケート結果
satoshi256kbyte
0
180
Introduction to Git & GitHub
latte72
0
120
decksh - a little language for decks
ajstarks
4
21k
「リーダーは意思決定する人」って本当?~ 学びを現場で活かす、リーダー4ヶ月目の試行錯誤 ~
marina1017
0
230
Featured
See All Featured
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
Into the Great Unknown - MozCon
thekraken
40
2k
Building Applications with DynamoDB
mza
96
6.6k
Done Done
chrislema
185
16k
The Cult of Friendly URLs
andyhume
79
6.5k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
8
890
GraphQLの誤解/rethinking-graphql
sonatard
71
11k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
131
19k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
139
34k
The Art of Programming - Codeland 2020
erikaheidi
55
13k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
9
770
For a Future-Friendly Web
brad_frost
179
9.9k
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再入門講座. 翔泳社.