Kotlin in Action, Second Edition

appendix B. Documenting Kotlin code

This appendix covers writing documentation comments for Kotlin code and generating API documentation for Kotlin modules.

Writing Kotlin documentation comments

The format used to write documentation comments for Kotlin declarations is called KDoc. KDoc comments begin with /** and use tags starting with @ to document specific parts of a declaration (as you might be used to from Javadoc). KDoc uses a dialect of Markdown (https://daringfireball.net/projects/markdown) as its syntax to write the comments itself. To make writing documentation comments easier, KDoc supports several additional conventions to refer to documentation elements, such as function parameters.

The following listing contains a simple example ...