Kotlin을 사용하는 Javadoc(dokka)를 사용하여 큐먼트화할 수 있습니다.
はじめに
Kotlin에서는 자바독(Javadoc)이 도카를 사용하여 더 많은 것을 사용할 수 있습니다.
dokkaは, デフォルトでprivateも含めてすべての可視性の要素가드큐먼트として出力されてしまい、ライブラリを公開 した際などに不要な要素などが混じっうまてまて.
その際, ドキュment 化する要素を可視性修飾子により決定する ことで、publicな要素のみをドキュmentととして公開で きてドキュMENTTOの可読性が向上します.その方法にかついついほす.
(前提) Kotlinの可視性修飾子
https://dogwood008.github.io/kotlin-web-site-ja/docs/reference/visibility-modifiers.htmlprivate
, protected
, internal
, public
の4つがあります.Javaでは internal
という可視性は存在しませんこれは同じモジュール内から参可能成.可能性.するときに非常に重宝しました(Javaの package protect
とほぼ同等かと思います)
(前提) dokkaの記述方法
build.gradle.kts
plugins {
id("org.jetbrains.dokka") version "1.6.21"
}
apply(plugin="org.jetbrains.dokka")
buildscript {
repositories {
jcenter()
}
dependencies {
classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.6.21")
}
}
以上を記述した上で、以下の코만두を実行します
gradle dokkaHtml
すると build/dokka/
配下に index.html
などが作成されるかと思います.
dokka의 출력력을 가 능한 視性修飾子により制御する方法
build.gradle.kts
import org.jetbrains.dokka.gradle.DokkaTask
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
configureEach {
documentedVisibilities.set(listOf(
org.jetbrains.dokka.DokkaConfiguration.Visibility.PUBLIC,
org.jetbrains.dokka.DokkaConfiguration.Visibility.PROTECTED
))
}
}
}
上記の例では DokkaTask
の configureEach
で出力する可視性として( Visibility.PUBLIC
, Visibility.PROTECTED
)を設定しました.
あとは、先程と同じように
gradle dokkaHtml
でpublic及びprotectedのみの要素のドキュmentトを生成する ことが可能입니다.
この DokkaTask
の configureEach
内には、他にもいろいろな項目が設定可能となっています.詳しくはこちらをご覧ください.
https://kotlin.github.io/dokka/1.6.21/user_guide/gradle/usage/
Reference
이 문제에 관하여(Kotlin을 사용하는 Javadoc(dokka)를 사용하여 큐먼트화할 수 있습니다.), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://dev.to/kabuakantech/kotlinyong-nojavadocdokkadedokiyumentohua-suruyao-su-woke-shi-xing-dezhi-yu-suru-j4
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
https://dogwood008.github.io/kotlin-web-site-ja/docs/reference/visibility-modifiers.html
private
, protected
, internal
, public
の4つがあります.Javaでは internal
という可視性は存在しませんこれは同じモジュール内から参可能成.可能性.するときに非常に重宝しました(Javaの package protect
とほぼ同等かと思います)(前提) dokkaの記述方法
build.gradle.kts
plugins {
id("org.jetbrains.dokka") version "1.6.21"
}
apply(plugin="org.jetbrains.dokka")
buildscript {
repositories {
jcenter()
}
dependencies {
classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.6.21")
}
}
以上を記述した上で、以下の코만두を実行します
gradle dokkaHtml
すると build/dokka/
配下に index.html
などが作成されるかと思います.
dokka의 출력력을 가 능한 視性修飾子により制御する方法
build.gradle.kts
import org.jetbrains.dokka.gradle.DokkaTask
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
configureEach {
documentedVisibilities.set(listOf(
org.jetbrains.dokka.DokkaConfiguration.Visibility.PUBLIC,
org.jetbrains.dokka.DokkaConfiguration.Visibility.PROTECTED
))
}
}
}
上記の例では DokkaTask
の configureEach
で出力する可視性として( Visibility.PUBLIC
, Visibility.PROTECTED
)を設定しました.
あとは、先程と同じように
gradle dokkaHtml
でpublic及びprotectedのみの要素のドキュmentトを生成する ことが可能입니다.
この DokkaTask
の configureEach
内には、他にもいろいろな項目が設定可能となっています.詳しくはこちらをご覧ください.
https://kotlin.github.io/dokka/1.6.21/user_guide/gradle/usage/
Reference
이 문제에 관하여(Kotlin을 사용하는 Javadoc(dokka)를 사용하여 큐먼트화할 수 있습니다.), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://dev.to/kabuakantech/kotlinyong-nojavadocdokkadedokiyumentohua-suruyao-su-woke-shi-xing-dezhi-yu-suru-j4
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
plugins {
id("org.jetbrains.dokka") version "1.6.21"
}
apply(plugin="org.jetbrains.dokka")
buildscript {
repositories {
jcenter()
}
dependencies {
classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.6.21")
}
}
gradle dokkaHtml
build.gradle.kts
import org.jetbrains.dokka.gradle.DokkaTask
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
configureEach {
documentedVisibilities.set(listOf(
org.jetbrains.dokka.DokkaConfiguration.Visibility.PUBLIC,
org.jetbrains.dokka.DokkaConfiguration.Visibility.PROTECTED
))
}
}
}
上記の例では
DokkaTask
の configureEach
で出力する可視性として( Visibility.PUBLIC
, Visibility.PROTECTED
)を設定しました.あとは、先程と同じように
gradle dokkaHtml
でpublic及びprotectedのみの要素のドキュmentトを生成する ことが可能입니다.
この
DokkaTask
の configureEach
内には、他にもいろいろな項目が設定可能となっています.詳しくはこちらをご覧ください.https://kotlin.github.io/dokka/1.6.21/user_guide/gradle/usage/
Reference
이 문제에 관하여(Kotlin을 사용하는 Javadoc(dokka)를 사용하여 큐먼트화할 수 있습니다.), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://dev.to/kabuakantech/kotlinyong-nojavadocdokkadedokiyumentohua-suruyao-su-woke-shi-xing-dezhi-yu-suru-j4텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)