2.7 KiB
Komentuj Swój Kod
Instrukcje
Czysty, dobrze udokumentowany kod jest niezbędny do utrzymania i udostępniania Twoich projektów. W tym zadaniu poćwiczysz jeden z najważniejszych nawyków profesjonalnych programistów: pisanie jasnych, pomocnych komentarzy, które wyjaśniają cel i funkcjonalność Twojego kodu.
Przejrzyj swój aktualny plik app.js w folderze gry i znajdź sposoby na skomentowanie go oraz uporządkowanie. Łatwo jest, żeby kod wymknął się spod kontroli, a teraz masz dobrą okazję, aby dodać komentarze, które zapewnią czytelność kodu, tak abyś mógł go później wykorzystać.
Twoje zadanie obejmuje:
- Dodanie komentarzy wyjaśniających, co robi każda główna sekcja kodu
- Dokumentowanie funkcji z jasnym opisem ich celu i parametrów
- Organizowanie kodu w logiczne bloki z nagłówkami sekcji
- Usunięcie nieużywanego lub zbędnego kodu
- Stosowanie spójnej konwencji nazewnictwa dla zmiennych i funkcji
Kryteria oceny
| Kryterium | Wzorowe | Wystarczające | Wymaga Poprawy |
|---|---|---|---|
| Dokumentacja kodu | Kod app.js jest w pełni skomentowany z jasnymi, pomocnymi wyjaśnieniami dla wszystkich głównych sekcji i funkcji |
Kod app.js jest odpowiednio skomentowany z podstawowymi wyjaśnieniami dla większości sekcji |
Kod app.js ma minimalne komentarze i brakuje mu jasnych wyjaśnień |
| Organizacja kodu | Kod jest zorganizowany w logiczne bloki z wyraźnymi nagłówkami sekcji i spójną strukturą | Kod ma pewną organizację z podstawowym grupowaniem powiązanej funkcjonalności | Kod jest dość nieuporządkowany i trudny do śledzenia |
| Jakość kodu | Wszystkie zmienne i funkcje mają opisowe nazwy, brak nieużywanego kodu, stosuje spójne konwencje | Większość kodu stosuje dobre praktyki nazewnictwa z minimalną ilością nieużywanego kodu | Nazwy zmiennych są niejasne, zawiera nieużywany kod, niestandardowy styl |
Zrzeczenie się odpowiedzialności:
Dokument ten został przetłumaczony przy użyciu usługi tłumaczenia AI Co-op Translator. Chociaż dokładamy wszelkich starań, aby tłumaczenie było jak najbardziej precyzyjne, prosimy pamiętać, że automatyczne tłumaczenia mogą zawierać błędy lub nieścisłości. Oryginalny dokument w jego oryginalnym języku należy uważać za źródło autorytatywne. W przypadku informacji krytycznych zaleca się skorzystanie z profesjonalnego tłumaczenia wykonanego przez człowieka. Nie ponosimy odpowiedzialności za jakiekolwiek nieporozumienia lub błędne interpretacje wynikające z korzystania z tego tłumaczenia.