Documentation

Last updated

What is Documentation?

Kotlin uses KDoc, a documentation generation tool, to create API documentation from comments in your code. These comments, similar to Javadoc, are placed above declarations (classes, functions, properties, etc.) and use a specific syntax to describe the element's purpose, parameters, return values, and other relevant information. Tools like Dokka then process these KDoc comments to generate HTML or other formats of documentation, making your code easier to understand and use by other developers.

More in stage 38: Documentation

Documentation: common questions

Can I learn Documentation in Hindi?

This lesson is written in English. Once you sign in, open it in the interactive course and ask the AI tutor to explain Documentation in Hindi or Hinglish. The tutor answers from this lesson’s own text, so it stays on the syllabus, and it runs on your own Google, OpenAI or Anthropic key.

Is this Documentation tutorial for beginners?

It is lesson 103 of 153 in the free Kotlin roadmap, in stage 38, Documentation. If you are new to Kotlin, start from stage 1 and come back here in order; if you already know the earlier stages, this lesson stands on its own.

Still confused? Ask me