Kotlin Multiplatform Academy · Lektion

Die API für beide Teams dokumentieren

KDoc schreiben, damit Android- und iOS-Entwickler die Verwendung einheitlich verstehen

Lektion 4 von 413 Schritte

Die API für beide Teams dokumentieren ist eine kostenlose Kotlin Multiplatform Academy-Lektion auf CoddyKit. Dies ist Lektion 4 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des Kotlin Multiplatform Academy-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der Kotlin Multiplatform Academy-Kurs umfasst insgesamt 4 Lektionen.

Docs Are Part of the API

Sowohl Android- als auch iOS-Entwickler rufen deinen geteilten Code auf, daher ist eine klare Dokumentation genauso wichtig wie die Funktionen selbst. 📝

Meet KDoc

KDoc ist der Dokumentationskommentar von Kotlin. Sie schreiben ihn direkt über eine Deklaration, und Tools machen daraus lesbare Referenzseiten.

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

Explain the Why

Code zeigt, was passiert; gute Dokumentation erklärt das Warum und die beabsichtigte Verwendung. Beschreiben Sie, was ein Aufrufer erwarten kann, nicht wie es im Inneren funktioniert.

Document Parameters

Verwenden Sie das @param-Tag, um jeden Eingang zu beschreiben. Aufrufer aus beiden Apps wissen dann genau, was sie übergeben müssen, ohne den Quelltext lesen zu müssen.

/**
 * @param rate tax rate as a fraction, like 0.2
 */

Document Return Values

Das @return-Tag beschreibt den Rückgabewert. Ein klarer Hinweistext verhindert falsche Annahmen bezüglich Einheiten, Wertebereichen oder Null-Werten.

/** @return total price including tax, never negative */

Link With Brackets

Schließe Namen in eckige Klammern ein, um Links zu erstellen, wie [Quote]. Leser springen in der generierten Dokumentation direkt zu verwandten Typen.

/** Builds a [Quote] from a base price. */

Show a Usage Sample

Ein winziges Beispiel schlägt seitenlange Erklärungen. Ein einzelner Codeausschnitt, der einen echten Aufruf zeigt, beantwortet die meisten Fragen, bevor sie überhaupt gestellt werden.

Document Only the Public API

Konzentrieren Sie Ihre Energie auf die öffentliche Schnittstelle. Interne Hilfsfunktionen können spärlich kommentiert bleiben, da kein externes Team sie aufruft.

Mind the iOS Reader

Auch Swift-Entwickler lesen Ihre KDoc. Beschreiben Sie das Verhalten daher in verständlichen Worten. Vermeiden Sie JVM-Jargon, der auf der iOS-Seite bedeutungslos ist.

Generate Docs With Dokka

Dokka liest Ihren KDoc ein und erstellt daraus eine durchsuchbare Website. Beide Teams arbeiten mit einer gemeinsamen Referenz, anstatt den Code erraten zu müssen.

Keep Docs in Sync

Veraltete Dokumentation stiftet mehr Verwirrung als gar keine Dokumentation. Aktualisieren Sie den KDoc im selben Änderungssatz (Change) wie den Code, damit beide stets synchron bleiben.

Quick Check

Prüfen wir dein Dokumentations-Wissen.

Beantworte es in der interaktiven Lektion

Recap

Schreiben Sie KDoc für Ihre öffentliche API, erklären Sie das Warum, taggen Sie Parameter und Rückgabewerte, fügen Sie ein Beispiel hinzu und lassen Sie Dokka es mit beiden Teams teilen. 🎉

Kostenlos starten

Lerne Kotlin mit einem KI-Tutor — kostenlos

Schreibe und führe echten Code in deinem Browser aus, bekomme sofortige Hilfe von einem 24/7 KI-Tutor und setze dein Lernen im Web oder in der App fort.

Kurse: 30
Lektionen: 120

Kostenlos lernen Den vollständigen Kurs ansehen

Häufig gestellte Fragen

Ist die Lektion „Die API für beide Teams dokumentieren“ kostenlos?

Ja — der vollständige Text von „Die API für beide Teams dokumentieren“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des Kotlin Multiplatform Academy-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der Kotlin Multiplatform Academy-Kurs umfasst insgesamt 4 Lektionen.

Was lerne ich in „Die API für beide Teams dokumentieren“?

KDoc schreiben, damit Android- und iOS-Entwickler die Verwendung einheitlich verstehen Du übst Kotlin Multiplatform Academy mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um Kotlin Multiplatform Academy zu starten?

Keine Vorkenntnisse erforderlich. Kotlin Multiplatform Academy auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 4 von 4.

Wie lange dauert die Lektion „Die API für beide Teams dokumentieren“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser Kotlin Multiplatform Academy-Lektion Code schreiben und ausführen?

Ja. Jede Kotlin Multiplatform Academy-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

← Zurück zu Kotlin Multiplatform Academy