Kotlin Multiplatform Academy · Lesson

Document the API for Both Teams

Write KDoc so Android and iOS devs agree on usage.

Docs Are Part of the API

Both Android and iOS devs call your shared code, so clear documentation is as important as the functions themselves. 📝

KDoc is Kotlin's documentation comment. You write it right above a declaration, and tools turn it into readable reference pages.

/** Returns a friendly greeting for [name]. */
fun greet(name: String) = "Hi, " + name