Kotlin in Action

Appendix B. Documenting Kotlin code

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

B.1. Writing Kotlin documentation comments

The format used to write documentation comments for Kotlin declarations is similar to Java’s Javadoc and is called KDoc. Just as in Javadoc, KDoc comments begin with /** and use tags starting with @ to document specific parts of a declaration. The key difference between Javadoc and KDoc is that the format used to write the comments themselves is Markdown (https://daringfireball.net/projects/markdown) rather than HTML. To make writing documentation comments easier, KDoc supports a number of additional conventions to refer to documentation elements ...