2.8 KiB
Kommentera din kod
Instruktioner
Ren och väl dokumenterad kod är avgörande för att underhålla och dela dina projekt. I denna uppgift kommer du att öva på en av de viktigaste vanorna hos professionella utvecklare: att skriva tydliga och hjälpsamma kommentarer som förklarar kodens syfte och funktionalitet.
Gå igenom din nuvarande app.js-fil i din spelmapp och hitta sätt att kommentera och städa upp den. Det är väldigt lätt för kod att bli oöverskådlig, och nu har du en bra chans att lägga till kommentarer för att säkerställa att du har läsbar kod som du kan använda senare.
Din uppgift inkluderar:
- Lägg till kommentarer som förklarar vad varje större kodsektion gör
- Dokumentera funktioner med tydliga beskrivningar av deras syfte och parametrar
- Organisera kod i logiska block med avsnittsrubriker
- Ta bort oanvänd eller överflödig kod
- Använd konsekventa namngivningskonventioner för variabler och funktioner
Bedömningskriterier
| Kriterier | Exemplariskt | Tillräckligt | Behöver förbättras |
|---|---|---|---|
| Koddokumentation | app.js-koden är fullt kommenterad med tydliga och hjälpsamma förklaringar för alla större sektioner och funktioner |
app.js-koden är tillräckligt kommenterad med grundläggande förklaringar för de flesta sektioner |
app.js-koden har minimala kommentarer och saknar tydliga förklaringar |
| Kodorganisation | Koden är organiserad i logiska block med tydliga avsnittsrubriker och konsekvent struktur | Koden har viss organisation med grundläggande gruppering av relaterad funktionalitet | Koden är något oorganiserad och svår att följa |
| Kodkvalitet | Alla variabler och funktioner använder beskrivande namn, ingen oanvänd kod, följer konsekventa konventioner | Det mesta av koden följer bra namngivningspraxis med minimal oanvänd kod | Variabelnamn är otydliga, innehåller oanvänd kod, inkonsekvent stil |
Ansvarsfriskrivning:
Detta dokument har översatts med hjälp av AI-översättningstjänsten Co-op Translator. Även om vi strävar efter noggrannhet, bör det noteras att automatiserade översättningar kan innehålla fel eller felaktigheter. Det ursprungliga dokumentet på dess ursprungliga språk bör betraktas som den auktoritativa källan. För kritisk information rekommenderas professionell mänsklig översättning. Vi ansvarar inte för eventuella missförstånd eller feltolkningar som uppstår vid användning av denna översättning.