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
180
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
170
10年モノのAndroidアプリのコード品質を改善していく、3つの取り組み
okuzawats
0
860
Androidアプリ開発におけるSonarCloudの活用
okuzawats
0
490
何故、UseCaseは1メソッドなのか
okuzawats
3
1k
例外を投げるな、値を返せ
okuzawats
9
7.1k
GitHub ActionsでAndroidアプリのテストを回しまくってたら全プロジェクトのCI/CDが完全停止する寸前だった件
okuzawats
0
230
Kotlinのifを愛でる
okuzawats
0
160
Say good-bye to Kotlin Android Extensions
okuzawats
0
150
Other Decks in Programming
See All in Programming
DocC Tutorial と TCA におけるテスト機能の紹介
kalupas226
1
330
とにかくHTTP3をライトニングに話す / Anyway, I'll talk to Lightning about HTTP3.
seike460
PRO
0
120
Ruby製社内ツールのGo移行
bgpat
2
270
もうすぐ新年度、Babylon.jsがお勧めな3個の理由
hideg
0
170
Prepare for Jakarta EE 11 - Performance and Developer Productivity
ivargrimstad
0
530
設計の知識と技能で駆動するソフトウェア開発
masuda220
PRO
18
11k
品質が高いコードって何?Rev2.1
ickx
1
490
オブジェクト指向コードレビューの新しいアプローチ
akkie76
3
1.5k
複雑なドメインを扱うプロダクトの探索フェーズではいつどのようにテストをするのか / How to testing during exploratory phase
boykush
2
150
導入から5年が経って見えた Datadog APM 運用の課題
bgpat
2
540
object-oriented-conference-2024
fuwasegu
6
2k
C# 大統一理論推進委員会 会員のための Unity Package Manager プロジェクト構成案
monry
PRO
0
580
Featured
See All Featured
Writing Fast Ruby
sferik
619
59k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
501
140k
Fontdeck: Realign not Redesign
paulrobertlloyd
75
4.8k
RailsConf 2023
tenderlove
0
510
Happy Clients
brianwarren
91
6.3k
Agile that works and the tools we love
rasmusluckow
323
20k
The Language of Interfaces
destraynor
150
23k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
67
38k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
185
15k
The Cost Of JavaScript in 2023
addyosmani
13
3.7k
StorybookのUI Testing Handbookを読んだ
zakiyama
10
4.5k
Web development in the modern age
philhawksworth
201
10k
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再入門講座. 翔泳社.