Мы используем файлы cookie
Мы используем файлы cookie для улучшения работы сайта и предоставления вам персонализированного опыта. Правила использования файлов cookie можно найти в нашей политике конфиденциальности
В Kotlin для документирования кода используется KDoc, который основан на синтаксисе JavaDoc.
Основные элементы KDoc:
/**
и заканчиваются на */
. Располагаются перед классом, функцией, свойством или другой сущностью, которую нужно описать.@param <имя параметра> <описание>
: Описывает параметр функции или конструктора.@return <описание>
: Описывает возвращаемое значение функции.@constructor <описание>
: Описывает конструктор класса.@throws <тип исключения> <описание>
: Описывает исключение, которое может быть выброшено.@sample <полное имя функции>
: Предоставляет пример использования документируемой сущности.@author <имя>
: Указывает автора кода.@since <версия>
: Указывает версию, в которой сущность была добавлена.@see <пункт назначения>
: Ссылается на другой связанный элемент документации.Пример использования KDoc:
kotlin
В Kotlin для документирования кода используется KDoc, который основан на синтаксисе JavaDoc.
Основные элементы KDoc:
/**
и заканчиваются на */
. Располагаются перед классом, функцией, свойством или другой сущностью, которую нужно описать.@param <имя параметра> <описание>
: Описывает параметр функции или конструктора.@return <описание>
: Описывает возвращаемое значение функции.@constructor <описание>
: Описывает конструктор класса.@throws <тип исключения> <описание>
: Описывает исключение, которое может быть выброшено.@sample <полное имя функции>
: Предоставляет пример использования документируемой сущности.@author <имя>
: Указывает автора кода.@since <версия>
: Указывает версию, в которой сущность была добавлена.@see <пункт назначения>
: Ссылается на другой связанный элемент документации.Пример использования KDoc:
kotlin
Зарегистрируйтесь или войдите, чтобы получить доступ к полным ответам на все вопросы из банка вопросов.