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
850
KDoc
Kotlinコードにドキュメントを書くためのKDocで使えるタグや記法について紹介
scache
September 18, 2017
Tweet
Share
More Decks by scache
See All by scache
ExoPlayerのトラック選択と再生中の解像度制限
sckm
0
150
Hyperion Item Nameplate
sckm
0
140
[紹介]Writing Your First Kotlin Compiler Plugin by Kevin Most
sckm
0
350
ChangeLogを読もう(1.2.70編)
sckm
1
370
3分でわかるSequence
sckm
1
720
Property + Getter
sckm
0
1.4k
略解reified
sckm
0
130
Other Decks in Technology
See All in Technology
これでもう迷わない!Jetpack Composeの書き方実践ガイド
zozotech
PRO
0
310
なぜテストマネージャの視点が 必要なのか? 〜 一歩先へ進むために 〜
moritamasami
0
210
データアナリストからアナリティクスエンジニアになった話
hiyokko_data
2
440
S3アクセス制御の設計ポイント
tommy0124
3
190
ChatGPTとPlantUML/Mermaidによるソフトウェア設計
gowhich501
1
130
Obsidian応用活用術
onikun94
1
460
Platform開発が先行する Platform Engineeringの違和感
kintotechdev
4
540
Autonomous Database - Dedicated 技術詳細 / adb-d_technical_detail_jp
oracle4engineer
PRO
4
10k
DDD集約とサービスコンテキスト境界との関係性
pandayumi
3
280
[ JAWS-UG 東京 CommunityBuilders Night #2 ]SlackとAmazon Q Developerで 運用効率化を模索する
sh_fk2
3
380
おやつは300円まで!の最適化を模索してみた
techtekt
PRO
0
290
会社紹介資料 / Sansan Company Profile
sansan33
PRO
6
380k
Featured
See All Featured
How STYLIGHT went responsive
nonsquared
100
5.8k
Java REST API Framework Comparison - PWX 2021
mraible
33
8.8k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
9
810
Facilitating Awesome Meetings
lara
55
6.5k
Music & Morning Musume
bryan
46
6.8k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
15
1.6k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
12
1.1k
What's in a price? How to price your products and services
michaelherold
246
12k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
194
16k
Code Review Best Practice
trishagee
70
19k
Being A Developer After 40
akosma
90
590k
Intergalactic Javascript Robots from Outer Space
tanoku
272
27k
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ʹग़ྗՄೳ