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
380
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
320
「Chatwork」Android版アプリを 支える単体テストの現在
okuzawats
0
250
カンファレンス参加をいかに正当化するか
okuzawats
0
240
「勉強になった」で終わらせない、ストロングスタイルの勉強会
okuzawats
0
350
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
1.2k
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
1.1k
何故、UseCaseは1メソッドなのか
okuzawats
3
1.8k
例外を投げるな、値を返せ
okuzawats
9
7.8k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
540
Other Decks in Programming
See All in Programming
気がついたら子供が社会人になって 自分と同じモバイルアプリエンジニアになった件 / Parent-Child Engineers
koishi
0
210
AIエージェントを活用したアプリ開発手法の模索
kumamotone
1
540
研究開発と実装OSSと プロダクトの好循環 / A virtuous cycle of research and development implementation OSS and products
linyows
1
140
⚪⚪の⚪⚪をSwiftUIで再現す る
u503
0
160
はじめてのIssueOps - GitHub Actionsで実現するコメント駆動オペレーション
tmknom
7
2k
Drawing Heighway’s Dragon- Recursive Function Rewrite- From Imperative Style in Pascal 64 To Functional Style in Scala 3
philipschwarz
PRO
0
210
Generative AI for Beginners .NETの紹介
tomokusaba
1
230
OUPC2024 Day 1 解説
kowerkoint
0
340
Jasprが凄い話
hyshu
0
260
‘무차별 LGTM~👍’만 외치던 우리가 ‘고봉밥 코드 리뷰’를?
hannah0731
0
420
Domain-Driven Design (Tutorial)
hschwentner
13
22k
RailsでCQRS/ESをやってみたきづき
suzukimar
2
1.2k
Featured
See All Featured
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
251
21k
We Have a Design System, Now What?
morganepeng
51
7.5k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
8
680
GraphQLとの向き合い方2022年版
quramy
44
14k
Making Projects Easy
brettharned
116
6.1k
Documentation Writing (for coders)
carmenintech
69
4.7k
How to train your dragon (web standard)
notwaldorf
91
5.9k
Building a Modern Day E-commerce SEO Strategy
aleyda
38
7.1k
Building Your Own Lightsaber
phodgson
104
6.3k
Producing Creativity
orderedlist
PRO
344
40k
Statistics for Hackers
jakevdp
797
220k
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再入門講座. 翔泳社.