FANDOM


Definicja

Komentarz - fragment kodu źródłowego, który jest pomijany w trakcie kompilacji.

UżycieEdytuj

Skoro komentarze się nie kompilują, to po co je w ogóle umieszczać w kodzie źródłowym? Odpowiedź na to pytanie jest prosta. Otóż komentarze przydają się do opisywania programu, zwiększania jego czytelności dla siebie i innych, a także używa się ich w przykładowych kodach służących do celów dydaktycznych, aby np. oznaczyć ważne wiersze lub ogólnie wytłumaczyć działanie fragmentu programu. Można również dzięki nim "wyłączyć" niepotrzebne linijki dla kompilatora i jednocześnie zostawić je w kodzie źródłowym np. do poprawy w przyszłości.

Zaleca się, aby używać komentarzy w swoim programie, oczywiście z umiarem. Nie warto opisywać działania każdej, prostej linijki... Naprawdę, przeglądający twój kod będą wiedzieli, że move(5); znaczy "porusz się robotem o 5 metró do przodu". W ten sposób tylko szybko się zmęczysz i zniechęcisz. Jednak swoje własne, skomplikowane "kwiatki" już warto opisywać. Np. ktoś przeglądający twój kod może się zastanowić "do czego właściwie służy ta funkcja/zmienna?", "co jest wynikiem tego skomplikowanego wyrażenia?", "co właściwie robi ta linijka i po co?".

Sposób użyciaEdytuj

  • komentarz liniowy - pozwala się umieścić w jednej linijce
// Komentarz
ToSieSkompiluje();
ToTezSieSkompiluje(); // Komentarz
  • komentarz blokowy - pozwala się umieścić w kilku linijkach
/* Komentarz */
ToSieSkompiluje();
/* Komentarz
ToSieNieSkompiluje(); */
/*
ToSieNieSkompiluje(); // komentarz liniowy
ToTezSieNieSkompiluje();
// komentarz liniowy
/* Komentarz blokowy w komentarzu blokowym
ToSieRowniezNieSkompiluje();
*/
*/

Przykłady użyciaEdytuj

Oddzielanie jednego większego fragmentu od drugiego.

// FUNKCJE
// =====================

// Funkcja1
// ---------------------
// ...
// ---------------------

// Funkcja2
// ---------------------
// ...
// ---------------------

// =====================

// GLOWNY PROGRAM
// =====================
extern void object::Poruszanie()
{
// ZMIENNE
// -----------------
// ...
// -----------------

// ...

// KOD ODPOWIEDZIALNY ZA ...
// -----------------
// ... 
// -----------------

// ...
}
// =====================

Opisanie, do czego służą zdefiniowane zmienne lub funkcje.

object item, power; // przedmiot przenosny i najblizsza bateria
int i, j, k; // zmienne pomocnicze (liczniki przedmiotow, liczniki petli)

int SprawdzBlad() // sprawdz, co poszlo nie tak. wynik przekazac funkcji Blad
{
// ...
}

void Blad(int jaki) // wyswietlanie komunikatu o bledzie
{
// ...
}

Onaczenie linijek (bardzo często na Wiki).

f1(); // 1
object item = radar(TitaniumOre); // 2
f2();
if(item != null) f3(); // 3

Pozbycie się fragmentu kodu, bez całkowitego usuwania.

f1();
int i = 1;
// f2();
if(i != 0)
{
 int a, b;
 a = 1;
 b = 0;
/*
 a = b;
 a++;
 f4();
*/
}

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.

Więcej z Fandomu

Losowa wiki