Komentarze C ++

„Celem komentarzy jest służenie dla Ciebie i poinformowanie innych. Objaśnienie dużych kodów tekstowych i fragmenty kodu, które należy skomentować podczas debugowania aplikacji są przykładami komentarzy wielopoziomowych. Kompilator nie bierze pod uwagę komentarzy. Komentarze w C ++ mogą mieć jedną lub więcej linii. Każda postać obecna w komentarzu jest pomijana przez kompilator C ++. Twoje komentarze powinny umożliwić zewnętrznym użytkownikom zrozumienie twojego kodu.

Jeśli komentarze dotyczące szczegółów programu nie zostaną dostarczone, ktoś czytający ogromną ilość kodu będzie zakłopotana. Uczynienie kodu bardziej zrozumiałym poprzez dodanie dodatkowych opisów jest możliwe z komentarzami. Aby kod jest zrozumiały, komentarze mogą zawierać opis algorytmu. Jeśli kod musi zostać ponownie wykorzystany po znacznej przerwie, komentarze mogą być również przydatne dla jednostki. Komentarze nie powinny być używane jako standarowanie w języku angielskim wyjaśnienie źle napisanego kodu. Pisanie czystego, samorozwajonego kodu powinno zawsze być priorytetem. Następnie użyj sekcji komentarzy."

Przykład 1

Komentarz jednoliniowy jest reprezentowany przez podwójne cięcie „//”. Komentarze jednoliniowe są wskazane za pomocą go. Można skomentować tylko jedną linię. Biorąc pod uwagę, że został zaprojektowany do pracy z programowaniem C ++, jest znany jako komentarze w stylu C ++.

#włączać
// Przykład komentarza jednego wiersza
int main ()

// Korpus głównej metody
STD :: Cout << "Single line comment in c++";
powrót 0;

Tutaj najpierw zaimportowaliśmy bibliotekę iostream z słowem kluczowym C ++. Następnie użyliśmy podwójnego cięcia „//” i wprowadziliśmy linię tekstową, która pokazuje, że jest to program komentarzy jednoliniowych. Wprowadzanie głównego ciała, w którym skomentowaliśmy również wiersz tekstowy, który określa, że ​​kod jest w sekcji głównej metody.

Komentarz jednoliniowy nie jest wyświetlany na ekranie konsoli.

Przykład 2

/*Dowolna linia tekstowa*/jest reprezentacją, z początkowym ukośnym ukośnikiem i gwiazdką (/*) i zakończeniem gwiazdki i cięcia do przodu (*/). Komentarze wieloletnie są wskazane za pomocą go. Komentarz może mieć wpływ na więcej niż jedną linię. Po raz pierwszy został użyty w programowaniu C, stąd nazwa „komentarz w stylu c."

/* Za pomocą wielu linii
Wykazano komentarz
W programie C ++.*/
#włączać
int main ()

/* Wewnątrz komentarza wielopoziomowego,
Kod jest wyjaśniony. Zmienna NUM to
zadeklarowane i wydrukowane na ekranie*/
int num = 25;
STD :: Cout << "The numbers is:";
STD :: Cout<powrót 0;

Tutaj rozpoczęliśmy nasz program od komentarza wielopasmowego. Jak omówiono, komentarz multiline wykorzystał pojedynczy slash „/” ze znakiem gwiazdki „*”. Owiniliśmy nasz akapit tekstowy w komentarzu multiline. Tekst podaje szczegóły, w których użyliśmy komentarzy multiline w programie C ++. Następnie musimy rozpocząć implementację programu, włączając moduł C ++. Następnie wprowadziliśmy główną metodę, w której ponownie użyliśmy skomentowanego tekstu multiline. Komentarz Multiline wyjaśnia, że ​​„NUM” to nazwa zmiennej i wyświetliśmy wartość zmienną „NUM” na ekranie.

Po kompilacji tego programu C ++ tylko instrukcja drukowania jest wyświetlana na podpowiedzi.

Przykład 3

Kod można również wyłączyć w komentarzach, aby powstrzymać go przed uruchomieniem. Na przykład, zamiast eliminować problematyczny kod, gdy napotykamy problem podczas wykonywania programu, możemy użyć komentarzy, aby zapobiec jego wykonaniu; To może być bardzo pomocne narzędzie do debugowania.

#włączać
za pomocą przestrzeni nazw Std;
int main ()
Cout << "C++ Program\n";
// cout <<"Error Program;
Cout << "C++ other Program";
powrót 0;

W powyższym programie celowo umieściliśmy polecenie błędu na cout. Zwróć uwagę, że w drugim poleceniu Cout ciąg jest poza cytatami, a my używamy pojedynczych cytatów. To generuje wyjątek.

Oto przykład wykorzystania komentarzy jako narzędzia do debugowania. Aby uniknąć generowania błędu, właśnie skomentowaliśmy polecenie błędu.

#włączać
za pomocą przestrzeni nazw Std;
int main ()
Cout << "C++ Program\n";
// cout <<"Error Program;
Cout << "C++ other Program";
powrót 0;

Teraz widzisz, że monit wydrukował instrukcje cout, a nie wygenerował wyjątku.

Przykład 4

Komentarze blokowe to szczególna forma komentarzy multiline, które są używane na początku każdego pliku lub funkcji. Stwórca i cel pliku są ujawniane w tych uwagach blokowych. Jak utworzyć komentarz blokowy, jest następujący:

• Aby upewnić się, że komentarz jest zgodny z następującym kodem, początkowa linia jest wcięta.
• Informacje o zamierzonym użyciu klasy lub funkcji znajdują się w komentarzu.
• Pomiędzy opisem pliku a listą tagów w komentarzu jest pusta linia.

/*
CS-102 C ++ 11, plik.CPP
Cel: Komentarze dokumentacji
@Author Linux_user
@Version 3.3 16/07/2022
*/
#włączać
za pomocą przestrzeni nazw Std;
int main ()
// cout<<"C++ eaxmple of Documentation comment"
// Wydrukuj instrukcję Cout
powrót 0;

Tutaj poprawnie udokumentowaliśmy ten kod programu za pomocą zablokowanych komentarzy. Możesz zobaczyć, że podaliśmy informacje o kodzie, który zawiera nazwę autora, szczegóły pliku, wersję oprogramowania, a także datę.

Przykład 5

Komentarz jednokierunkowy może być zagnieżdżony w innym komentarzu, który ma kilka wierszy. Tę logikę tę logikę nie ma zastosowania par. Nie ma sposobu na gniazdowanie jednego z wielu linii w drugim.

#włączać
za pomocą przestrzeni nazw Std;
int main ()
/*
// Komentarz z pojedynczym wierszem
// Komentarz multiline zacznij tutaj, a linia komentarzy kończy się tutaj */
powrót 0;

W tym konkretnym przykładzie wykorzystaliśmy zagnieżdżony komentarz jednokierunkowy z reprezentacją komentarza wielopoziomowego. Owiniliśmy nasz jednokinowy komentarz z pojedynczym slashem „/” i gwiazdką „*”. W ten sposób możemy komentować kilka wierszy tekstu w C++.

Wniosek

Zbadano zarówno jednokierunkowe, jak i wieloletnie komentarze C#. Komentarze, które są jedną linią, kończą się na pierwszej przerwie, która pojawia się po znaczniku komentarza //. Umieść go po instrukcji kodu, albo umieść go na górze. Jest to uważane za komentarz, jeśli pojawia się po oświadczeniu kodowym. Podczas kompilacji tylko tekst, który jest obecny między ograniczeniami komentarzy, zostanie uznany za komentarz.