Articles of Javadoc

Kotlin Generate Comment Doc

С Java мы использовали /** перед методом, и хороший автоматический генерируемый документ просто появился бы. Не могу сделать то же самое с Котлином. Доступна ли эта функция по умолчанию? Как я могу включить его?

Kotlin – исключение документа, созданное методом интерфейса

Поскольку Kotlin не имеет проверенного исключения, каков правильный способ документировать исключение, которое, как ожидается, будет вызвано интерфейсом? Должен ли я документировать его в интерфейсе или в классе реализации (только если конкретный метод действительно его выбрасывает)?

Форматирование комментариев Kotlin в IntelliJ / Android Studio

Есть ли способ форматировать длинные комментарии Kotlin в IntelliJ IDEA / Android Studio так же, как комментарии Java при настройке: Стиль кода> Java> JavaDoc> Обтекание на правом краю Когда вы включаете эту настройку, после форматирования она поворачивается так: /** * This is my very very very long comment which probably should be multi-line…. */ в […]

Документация Kotlin не поддерживает теги типа «<p>»

Я пишу комментарии к документу для описания метода. /** * <p>necessary * <p>setType is to set the PendingIntend's request code</p> */ Но он не будет показывать абзацы. Если я не использую <p> , вся документация находится в строке без перерыва. Он работает в Java-классе, но когда дело доходит до Kotlin, я не знаю, как с […]

Dokka – пропустить генератор javadoc для пакетов по умолчанию для Android

Я пытаюсь использовать плагин Dokka для создания Javadoc для приложения Android Kotlin. Я добавил плагин к своей градиенте: classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" Затем я выполнил базовую конфигурацию, следуя инструкциям проекта: dokka { outputFormat = 'javadoc' outputDirectory = "$rootDir/docs" skipEmptyPackages = true noStdlibLink = true } Я создаю документацию с помощью базовой команды gradle: [user@linux AppDir]$ bash gradlew […]

Как мне наследовать документацию KDoc?

В Java Javadoc существует способ наследования документации метода в подклассе с использованием тега {@inheritDoc} . Есть ли способ сделать то же самое в KDoc Kotlin? В основном, я хотел бы сделать следующее: abstract class Base { /** * Some KDoc documentation here. */ abstract fun foo() } class Derived: Base() { /** * Here is […]