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
380
「Chatwork」Android版アプリを 支える単体テストの現在
okuzawats
0
320
カンファレンス参加をいかに正当化するか
okuzawats
0
280
「勉強になった」で終わらせない、ストロングスタイルの勉強会
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
590
Other Decks in Programming
See All in Programming
Comparing decimals in Swift Testing
417_72ki
0
130
[Codecon - 2025] Como não odiar seus testes
camilacampos
0
100
PHPカンファレンス関西2025 基調講演
sugimotokei
5
1k
階層化自動テストで開発に機動力を
ickx
1
440
AI Agent 時代のソフトウェア開発を支える AWS Cloud Development Kit (CDK)
konokenj
6
1k
Strands Agents で実現する名刺解析アーキテクチャ
omiya0555
1
110
SQLアンチパターン第2版 データベースプログラミングで陥りがちな失敗とその対策 / Intro to SQL Antipatterns 2nd
twada
PRO
35
10k
202507_ADKで始めるエージェント開発の基本 〜デモを通じて紹介〜(奥田りさ)The Basics of Agent Development with ADK — A Demo-Focused Introduction
risatube
PRO
5
1.2k
構造化・自動化・ガードレール - Vibe Coding実践記 -
tonegawa07
0
150
ZeroETLで始めるDynamoDBとS3の連携
afooooil
0
130
「次に何を学べばいいか分からない」あなたへ──若手エンジニアのための学習地図
panda_program
3
670
Advanced Micro Frontends: Multi Version/ Framework Scenarios
manfredsteyer
PRO
0
120
Featured
See All Featured
The World Runs on Bad Software
bkeepers
PRO
70
11k
jQuery: Nuts, Bolts and Bling
dougneiner
63
7.8k
The Cult of Friendly URLs
andyhume
79
6.5k
BBQ
matthewcrist
89
9.8k
Rails Girls Zürich Keynote
gr2m
95
14k
Documentation Writing (for coders)
carmenintech
72
4.9k
How GitHub (no longer) Works
holman
314
140k
Why Our Code Smells
bkeepers
PRO
337
57k
Making Projects Easy
brettharned
117
6.3k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
8
720
The Invisible Side of Design
smashingmag
301
51k
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再入門講座. 翔泳社.