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
430
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
400
「Chatwork」Android版アプリを 支える単体テストの現在
okuzawats
0
350
カンファレンス参加をいかに正当化するか
okuzawats
0
300
「勉強になった」で終わらせない、ストロングスタイルの勉強会
okuzawats
0
400
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
1.3k
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
1.2k
何故、UseCaseは1メソッドなのか
okuzawats
3
2.1k
例外を投げるな、値を返せ
okuzawats
9
8.1k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
620
Other Decks in Programming
See All in Programming
CSC305 Lecture 03
javiergs
PRO
0
230
Catch Up: Go Style Guide Update
andpad
0
170
Web技術を最大限活用してRAW画像を現像する / Developing RAW Images on the Web
ssssota
2
1.2k
フロントエンド開発に役立つクライアントプログラム共通のノウハウ / Universal client-side programming best practices for frontend development
nrslib
7
3.9k
高度なUI/UXこそHotwireで作ろう Kaigi on Rails 2025
naofumi
4
3.4k
AIで開発生産性を上げる個人とチームの取り組み
taniigo
0
130
CSC305 Lecture 02
javiergs
PRO
1
260
開発生産性を上げるための生成AI活用術
starfish719
1
170
monorepo の Go テストをはやくした〜い!~最小の依存解決への道のり~ / faster-testing-of-monorepos
convto
2
390
After go func(): Goroutines Through a Beginner’s Eye
97vaibhav
0
230
プロダクト開発をAI 1stに変革する〜SaaS is dead時代で生き残るために〜 / AI 1st Product Development
kobakei
0
490
CSC305 Lecture 01
javiergs
PRO
1
400
Featured
See All Featured
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
114
20k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
9
850
Gamification - CAS2011
davidbonilla
81
5.5k
Visualization
eitanlees
148
16k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
52
5.6k
BBQ
matthewcrist
89
9.8k
Distributed Sagas: A Protocol for Coordinating Microservices
caitiem20
333
22k
Build your cross-platform service in a week with App Engine
jlugia
232
18k
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
A Modern Web Designer's Workflow
chriscoyier
697
190k
Thoughts on Productivity
jonyablonski
70
4.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再入門講座. 翔泳社.