Jak pisać komentarze w programowaniu C
Benjamin Walker
Co to jest komentarz w języku C?
A komentarz to wyjaśnienie lub opis kodu źródłowego programu. Pomaga programiście wyjaśnić logikę kodu i poprawia czytelność programu. W czasie wykonywania komentarz jest ignorowany przez kompilator.
W języku C występują dwa rodzaje komentarzy:
1) Komentarz zaczynający się od ukośnika /* i kończący się ukośnikiem */, który można umieścić w dowolnym miejscu kodu, w tej samej linii lub w kilku liniach.
2) Komentarze jednowierszowe, w których stosuje się podwójny ukośnik // przeznaczony do komentowania pojedynczych wierszy
Przykładowy komentarz jednowierszowy
// single line comment example
Oto przykład typu komentarzy
// C program to demo
// Single Line comment
#include <stdio.h>
int main(void)
{
// This is a single line comment
printf("Guru99");
return 0; // return zero
}
Przykładowy komentarz wielowierszowy
/* Sample Multiline Comment Line 1 Line 2 …. … */
Przykładowy komentarz wielowierszowy
#include <stdio.h>
int main() {
/* in main function
I can write my principal code
And this in several comments line */
int x = 42; //x is a integer variable
printf("%d", x);
return 0;}
Dlaczego potrzebujesz komentarzy?
Dobry programista piszący kody zrozumiałe dla człowieka jest lepszy niż programista generujący kody zrozumiałe tylko dla maszyny.
Dlatego zdecydowanie zaleca się wstawianie komentarzy do kodu, ponieważ jest to dobra praktyka programistyczna. Komentarze nie mają wpływu na program, ponieważ kompilator ignoruje je.
Komentarze pomagają programiście zrozumieć logikę/algorytm kodu, jeśli ponownie odwiedzi go po długim czasie.
