2.8 KiB
Kommentieren Sie Ihren Code
Anleitung
Sauberer, gut dokumentierter Code ist unerlässlich, um Ihre Projekte zu pflegen und weiterzugeben. In dieser Aufgabe üben Sie eine der wichtigsten Gewohnheiten professioneller Entwickler: das Schreiben klarer, hilfreicher Kommentare, die den Zweck und die Funktionalität Ihres Codes erklären.
Gehen Sie Ihre aktuelle app.js-Datei in Ihrem Spieleordner durch und finden Sie Möglichkeiten, diese zu kommentieren und aufzuräumen. Es ist sehr leicht, dass Code außer Kontrolle gerät, und jetzt ist eine gute Gelegenheit, Kommentare hinzuzufügen, um sicherzustellen, dass Sie lesbaren Code haben, den Sie später verwenden können.
Ihre Aufgabe umfasst:
- Fügen Sie Kommentare hinzu, die erklären, was jeder wichtige Abschnitt des Codes macht
- Dokumentieren Sie Funktionen mit klaren Beschreibungen ihres Zwecks und ihrer Parameter
- Organisieren Sie den Code in logische Abschnitte mit Überschriften
- Entfernen Sie nicht verwendeten oder redundanten Code
- Verwenden Sie konsistente Benennungskonventionen für Variablen und Funktionen
Bewertungsbogen
| Kriterien | Hervorragend | Ausreichend | Verbesserungsbedarf |
|---|---|---|---|
| Code-Dokumentation | app.js ist vollständig kommentiert mit klaren, hilfreichen Erklärungen für alle wichtigen Abschnitte und Funktionen |
app.js ist angemessen kommentiert mit grundlegenden Erklärungen für die meisten Abschnitte |
app.js hat minimale Kommentare und fehlt an klaren Erklärungen |
| Code-Organisation | Code ist in logische Abschnitte mit klaren Überschriften und konsistenter Struktur unterteilt | Code hat eine gewisse Organisation mit grundlegender Gruppierung verwandter Funktionen | Code ist etwas unorganisiert und schwer nachvollziehbar |
| Code-Qualität | Alle Variablen und Funktionen verwenden beschreibende Namen, kein ungenutzter Code, konsistente Konventionen | Die meisten Codes folgen guten Namenskonventionen mit minimal ungenutztem Code | Variablennamen sind unklar, enthält ungenutzten Code, inkonsistenter Stil |
Haftungsausschluss:
Dieses Dokument wurde mithilfe des KI-Übersetzungsdienstes Co-op Translator übersetzt. Obwohl wir nach Genauigkeit streben, beachten Sie bitte, dass automatisierte Übersetzungen Fehler oder Ungenauigkeiten enthalten können. Das Originaldokument in seiner Originalsprache gilt als maßgebliche Quelle. Für wichtige Informationen wird eine professionelle menschliche Übersetzung empfohlen. Wir übernehmen keine Haftung für Missverständnisse oder Fehlinterpretationen, die durch die Nutzung dieser Übersetzung entstehen.