Kuidas kirjutada C-programmeerimises kommentaare

Autor: Benjamini jalutaja Benjamini jalutaja
Hours Ajakohastatud

Mis on kommentaar C-keeles?

A kommentaar on programmi lähtekoodi selgitus või kirjeldus. See aitab arendajal selgitada koodi loogikat ja parandab programmi loetavust. Käitusajal ignoreerib kompilaator kommentaari.

C-s on kahte tüüpi kommentaare:

1) Kommentaar, mis algab kaldkriipsuga tärniga /* ja lõpeb kaldkriipsuga */ ning võid selle paigutada koodis ükskõik kuhu, samale reale või mitmele reale.

2) Üherealised kommentaarid, mis kasutab topeltkaldkriipsu //, mis on pühendatud üksikute ridade kommenteerimiseks

Üherealise kommentaari näide

// single line comment example

Siin on näide kommentaaride tüübist

// 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
}

Mitmerealise kommentaari näide

/* Sample Multiline Comment
Line 1
Line 2
….
…
*/

Mitmerealise kommentaari näide

#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;}

Miks teil kommentaare vaja on?

Hea programmeerija, kes kirjutab inimesele arusaadavaid koode, on parem kui programmeerija, kes genereerib ainult masinale mõistetavaid koode.

Seega on tungivalt soovitatav lisada oma koodile kommentaare, kuna see on hea programmeerimise tava. Kommentaarid ei mõjuta programmi, kuna kompilaator ignoreerib neid.

Kommentaarid aitavad arendajal koodi loogikat/algoritmi mõista, kui ta seda pika aja pärast uuesti vaatab.