Co zrobić, gdy musisz napisać swój pierwszy (lub jeden z pierwszych) komentarz? Przede wszystkim musi opisywać kod, przy którym się pojawia. Zakłada się, że zapisywane są tylko komentarze, które są lokalne, nie zawierają informacji ogólnosystemowych. Komentarz nie opisuje funkcji,
Pamiętaj! Komentarz to nie miejsce na prowadzenie dyskusji albo pole do wpisywania nieznaczących szczegółów. Został on wyszczegółowiony z modułu zaprojektowanego w celu przetestowania funkcji (kodowanie/ dekodowanie) .
Relacja pomiędzy komentarzem a kodem powinna być oczywista. Komentując chcesz, aby osoba przeglądająca Twój kod, była w stanie go zrozumieć. Mało precyzyjny komentarz może przynieść więcej szody niż pożytku.
Czytelność kodu będzie miała ogromny wpływ na wszystkie zmiany, które kiedykolwiek zostaną wprowadzone. Styl kodowania i czytelność ustanawiają precedensy, które nadal wpływają na utrzymanie i rozszerzalność długo po tym, jak oryginalny kod został zmieniony. Komentarze pełnią wyłącznie ostateczny dodatek.
Zespół GREAT
Więcej wiadomości znajdziesz na naszej stronie.