Podczas programowania na komputerze czasami konieczne jest pozostawienie notatek lub komentarzy, aby inni programiści mogli z łatwością przeglądać Twój kod. Niezależnie od tego, czy jest to projekt open source, czy projekt zastrzeżony, potrzebne są komentarze w celu koordynacji ze współtwórcami i potencjalnymi przyszłymi deweloperami. Bez komentarzy kod byłby po prostu nie do utrzymania.
Kroki
Krok 1. Zrozum cel komentowania programu komputerowego
- Czytelność jest tutaj kluczowa. Kiedy patrzysz na komentarz, powinieneś wiedzieć, że jest to komentarz, a nie wiersz kodu.
- Komentarz powinien być również pomocny nie tylko dla Ciebie, ale dla każdego, kto może przeczytać kod źródłowy Twojego programu komputerowego.
Krok 2. Pomyśl o krótkim, prostym sposobie na przedstawienie swojego punktu widzenia
Komentarze nie muszą być dziełem sztuki. Powinny być zwięzłe, schludne i bezpośrednie.
Nie powinno to jednak zniechęcać do używania wielu wierszy w komentarzu. Chodzi o to, że informacja musi dotrzeć do czytelnika
Krok 3. Napisz komentarz używając odpowiedniej składni podanej przez język programowania
Krok 4. Zadaj sobie pytanie, czy napisany przez Ciebie komentarz jest wystarczająco szczegółowy
Komentarz powinien być w stanie powiedzieć komuś patrzącemu na kod źródłowy, co ta część programu faktycznie robi, bez konieczności jej kompilowania i uruchamiania. Czy twój komentarz to osiąga? Czy przekazuje wszystkie szczegóły?
