Spec-Zone.ru › Kotlin 1.9

Введение

Dokka — это движок для документации API на Kotlin.

Как и сам Kotlin, Dokka поддерживает проекты с несколькими языками. Он понимает комментарии KDoc для Kotlin и комментарии Javadoc для Java.

Dokka может генерировать документацию в нескольких форматах, включая собственный современный формат HTML, различные варианты Markdown и Javadoc HTML от Java.

Вот некоторые библиотеки, которые используют Dokka для документации ссылок по API:

  • kotlinx.coroutines

  • Bitmovin

  • Hexagon

  • Ktor

  • OkHttp (Markdown)

Вы можете запустить Dokka с помощью Gradle, Maven или из командной строки. Также Dokka высоко настраиваемый.

См. Начало работы с Dokka, чтобы сделать первые шаги.

Сообщество

Dokka имеет специальный #dokka канал в Kotlin Community Slack, где можно обсудить Dokka, его плагины и их разработку, а также связаться с разработчиками.

Последнее изменение: 25 июля 2023 г.
Ant Начало работы с Dokka

© 2010–2023 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/docs/dokka-introduction.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API