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
210
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
200
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
910
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
570
何故、UseCaseは1メソッドなのか
okuzawats
3
1.1k
例外を投げるな、値を返せ
okuzawats
9
7.2k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
280
Kotlinのifを愛でる
okuzawats
0
200
Say good-bye to Kotlin Android Extensions
okuzawats
0
170
Other Decks in Programming
See All in Programming
SIMD Parallel Programming with the Vector API
josepaumard
0
230
Fast JSX: Don't clone props object #28768
yossydev
1
200
AWS CDKコントリビュートTIPS / aws-cdk-contribution-tips
gotok365
4
410
Apache Hive 4 on Treasure Data
ryukobayashi
1
440
Kotlin Multiplatform at Stable and Beyond (Android Makers 2024)
zsmb
0
520
Goのエラースタックトレースの歴史と今後
sonatard
10
1.8k
Ruby GitHub Packages
bkuhlmann
0
640
Anthropic Cookbook のおすすめレシピ
schroneko
7
1.3k
障害対応を起点としたもっといい開発と運用のサイクル作りのためにできること / Hatena Enginner Seminar #29
polamjag
0
400
SwiftUIで使いやすいToastの作り方 / How to build a Toast system which is easy to use in SwiftUI
lovee
3
180
slow types ってなんだろう?
karad
0
120
AmperとFleetを使ったAndroidアプリ
yoppie
0
260
Featured
See All Featured
Designing the Hi-DPI Web
ddemaree
276
33k
Documentation Writing (for coders)
carmenintech
60
4k
Statistics for Hackers
jakevdp
790
220k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
123
39k
The Straight Up "How To Draw Better" Workshop
denniskardys
228
130k
Writing Fast Ruby
sferik
622
60k
What's new in Ruby 2.0
geeforr
337
31k
Building Flexible Design Systems
yeseniaperezcruz
320
37k
Principles of Awesome APIs and How to Build Them.
keavy
121
16k
Building a Scalable Design System with Sketch
lauravandoore
457
32k
Mobile First: as difficult as doing things right
swwweet
217
8.6k
Being A Developer After 40
akosma
67
580k
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再入門講座. 翔泳社.