Hogyan írjunk megjegyzéseket a C programozásban

By: Benjamin walker Benjamin walker
Hours korszerűsített

Mi a megjegyzés a C nyelvben?

A megjegyzés a program forráskódjának magyarázata vagy leírása. Segít a fejlesztőnek elmagyarázni a kód logikáját, és javítja a program olvashatóságát. Futás közben a fordító figyelmen kívül hagyja a megjegyzést.

A C-ben kétféle megjegyzés létezik:

1) Egy megjegyzés, amely egy perjellel kezdődik /* és egy csillag perjel */ végződik, és bárhová elhelyezheti a kódban, ugyanabban a sorban vagy több sorban.

2) Egysoros megjegyzések, amelyek dupla perjelet // használnak az egysoros megjegyzésekhez

Példa egysoros megjegyzésre

// single line comment example

Íme egy példa a megjegyzések típusára

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

Példa többsoros megjegyzésre

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

Példa többsoros megjegyzésre

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

Miért van szükséged megjegyzésekre?

Az a jó programozó, aki ember által értett kódokat ír, jobb, mint az a programozó, aki csak a gép által értett kódokat generál.

Ezért erősen ajánlott megjegyzéseket illeszteni a kódhoz, mert ez egy jó programozási gyakorlat. A megjegyzések nem érintik a programot, mert a fordítóprogram figyelmen kívül hagyja őket.

A megjegyzések segítenek a fejlesztőnek megérteni a kód logikáját/algoritmusát, ha hosszú idő után újra megtekinti.