This article assumes you have previous experience developing for Android in Kotlin. Note: This article uses an Android project to showcase KDoc and Dokka, but you can apply the concepts shown to any Kotlin project. Making it easy for other developers to use your project is a challenging but rewarding task - and good documentation plays a major role in it.īy the end of this article, you’ll have documentation generated in HTML for the notktx project. The major target audience for libraries is usually other developers, so documenting a library project can be a great way to understand how to go about documenting codebases. You’ll work on an Android library project called notktx and generate customized documentation for it.
How documentation can help you to improve the quality of your projects.
From simple comments that live alongside the code to complex websites like the Android Developer documentation that cover things like platform APIs, build tools, samples, etc., it’s all documentation. Good documentation can make a developer prefer one library over others.ĭocumentation comes in many forms.
0 kommentar(er)
