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
Search
scache
September 18, 2017
Technology
1
830
KDoc
Kotlinコードにドキュメントを書くためのKDocで使えるタグや記法について紹介
scache
September 18, 2017
Tweet
Share
More Decks by scache
See All by scache
ExoPlayerのトラック選択と再生中の解像度制限
sckm
0
110
Hyperion Item Nameplate
sckm
0
140
[紹介]Writing Your First Kotlin Compiler Plugin by Kevin Most
sckm
0
340
ChangeLogを読もう(1.2.70編)
sckm
1
360
3分でわかるSequence
sckm
1
710
Property + Getter
sckm
0
1.4k
略解reified
sckm
0
130
Other Decks in Technology
See All in Technology
Wasm元年
askua
0
140
IIWレポートからみるID業界で話題のMCP
fujie
0
780
Oracle Cloud Infrastructure:2025年6月度サービス・アップデート
oracle4engineer
PRO
2
230
AWS アーキテクチャ作図入門/aws-architecture-diagram-101
ma2shita
29
10k
5min GuardDuty Extended Threat Detection EKS
takakuni
0
120
_第3回__AIxIoTビジネス共創ラボ紹介資料_20250617.pdf
iotcomjpadmin
0
150
Кто отправит outbox? Валентин Удальцов, автор канала Пых
lamodatech
0
330
Amazon ECS & AWS Fargate 運用アーキテクチャ2025 / Amazon ECS and AWS Fargate Ops Architecture 2025
iselegant
16
5.4k
エンジニア向け技術スタック情報
kauche
1
250
Model Mondays S2E02: Model Context Protocol
nitya
0
220
登壇ネタの見つけ方 / How to find talk topics
pinkumohikan
3
350
Snowflake Summit 2025全体振り返り / Snowflake Summit 2025 Overall Review
mtpooh
2
390
Featured
See All Featured
Statistics for Hackers
jakevdp
799
220k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
46
9.6k
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
Automating Front-end Workflow
addyosmani
1370
200k
Into the Great Unknown - MozCon
thekraken
39
1.9k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
Designing for Performance
lara
609
69k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
44
2.4k
Visualization
eitanlees
146
16k
A designer walks into a library…
pauljervisheath
206
24k
Bash Introduction
62gerente
614
210k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
31
1.2k
Transcript
KDoc Ryo Sotoyama( @scal_ch )
About Me • ֎ࢁ ໆ (Ryo Sotoyama) • Twitter: @scal_ch
• AndroidΞϓϦ࡞ͬͯ·͢
KDoc • KotlinͷυΩϡϝϯτهड़༻ݴޠ • Javadocͱॻ͖ํࣅ͍ͯΔ
Summary, Detailed Description fun doc() {}
Summary, Detailed Description /** * ࠷ॳͷߦʹ֓ཁΛॻ͘ */ fun doc() {}
Summary, Detailed Description /** * ࠷ॳʹ֓ཁΛॻ͘ * * վߦͨ͠ޙʹৄࡉΛॻ͘ */
fun doc() {}
Link /** * ΫϥεͷϦϯΫ [android.app.Activity] */ fun doc() {}
Link import android.app.Activity /** * ActivityͷϦϯΫ [Activity] */ fun doc()
{}
Link import android.app.Activity /** * [ActivityͷϦϯΫ][Activity] */ fun doc() {}
Link import android.app.Activity /** * [ؔͷϦϯΫ][Activity.onCreate] */ fun doc() {}
Link /** * [github](https://github.com/sckm) */ fun doc() {}
Block Tags
Function fun doc() { ... }
Function /** * @param arg argʹ͍ͭͯ */ fun doc(arg: String)
{ ... }
Function /** * @param[arg] argʹ͍ͭͯ */ fun doc(arg: String) {
... }
Function /** * @param arg argʹ͍ͭͯ * @return Γʹ͍ͭͯ */
fun doc(arg: String): Int { ... }
Function /** * @param arg argʹ͍ͭͯ * @return Γʹ͍ͭͯ *
@receiver Ϩγʔόʹ͍ͭͯ */ fun String.doc(arg: String): Int { ... }
Function /** * @param T ܕύϥϝʔλT * @param arg argʹ͍ͭͯ
* @return Γʹ͍ͭͯ * @receiver Ϩγʔόʹ͍ͭͯ */ fun <T> T.doc(arg: String): Int { ... }
Function /** * @param T ܕύϥϝʔλT * @param arg argʹ͍ͭͯ
* @return Γʹ͍ͭͯ * @receiver Ϩγʔόʹ͍ͭͯ * @throws IllegalArgumentException ྫ֎ * @exception IllegalArgumentException ྫ֎ */ fun <T> T.doc(arg: String): Int { ... }
Function /** * @param T ܕύϥϝʔλT * @param arg argʹ͍ͭͯ
* @return Γʹ͍ͭͯ * @receiver Ϩγʔόʹ͍ͭͯ * @throws IllegalArgumentException ྫ֎ * @exception IllegalArgumentException ྫ֎ */ fun <T> T.doc(arg: String): Int { ... }
Class class Doc
Class /** * @constructor ϓϥΠϚϦίϯετϥΫ */ class Doc(val p: String)
Class /** * @constructor ϓϥΠϚϦίϯετϥΫ * @property p ϓϩύςΟp */
class Doc(val p: String)
Sample fun usage() { val s = "str" doc(s) }
/** * @sample usage */ fun doc(arg: String): Int { ... }
Sample fun usage() { val s = "str" doc(s) }
/** * @sample usage */ fun doc(arg: String): Int { ... }
Tags /** * @see android.app.Activity * @author scache * @since
1.0 * @suppress */ class BlockTags
Tags /** * @see android.app.Activity * @author scache * @since
1.0 * @suppress */ class BlockTags
Tags /** * @see android.app.Activity * @author scache * @since
1.0 * @suppress */ class BlockTags
Tags /** * @see android.app.Activity * @author scache * @since
1.0 * @suppress */ class BlockTags
• Javadocͱॻ͖ํ΄ͱΜͲಉ͡ • DokkaΛ͏ͱhtmlʹग़ྗՄೳ