Ebben a cikkben megtudhatjuk a C # megjegyzéseket, a megjegyzések különböző stílusát, valamint a programban való felhasználás miértjét és módját.
A megjegyzéseket egy programban használják, hogy segítsenek nekünk egy kódrészlet megértésében. Emberileg olvasható szavak, amelyek célja a kód olvashatóvá tétele. A fordító teljesen figyelmen kívül hagyja a megjegyzéseket.
A C # kategóriában 3féle megjegyzés létezik:
- Egysoros megjegyzések (
//) - Többsoros megjegyzések (
/* */) - XML-megjegyzések (
///)
Egysoros megjegyzések
Az egysoros megjegyzések kettős perjellel kezdődnek //. A fordító mindent figyelmen kívül hagy //a sor végéig. Például,
int a = 5 + 7; // 5. és 7. hozzáadása
Itt Adding 5 and 7van a megjegyzés.
1. példa: Egysoros megjegyzés használata
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
A fenti program 3 egysoros megjegyzést tartalmaz:
// Hello World Program // A végrehajtás a Fő módszerből indul
és
// Helló világot nyomtat
Az egysoros megjegyzéseket külön sorban vagy ugyanazon sorban található kódokkal együtt lehet megírni. Javasoljuk azonban, hogy a megjegyzéseket külön sorban használja.
Többsoros megjegyzések
A többsoros megjegyzések kezdete /*és vége */. A többsoros megjegyzések több sorra is kiterjedhetnek.
2. példa: Többsoros megjegyzés használata
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
A fenti program 2 többsoros megjegyzést tartalmaz:
/ * Ez egy Hello World program C # nyelven. Ez a program a Hello World programot nyomtatja ki. * /
és
/ * Helló világot nyomtat * /
Itt észrevehettük, hogy a többsoros megjegyzés nem kötelező több soron átívelnie. /*… */egysoros megjegyzések helyett használható.
XML dokumentációs megjegyzések
Az XML dokumentációs megjegyzés a C # egyik különlegessége. Hármas perjellel kezdődik, és egy kóddarab ///kategorikus leírására szolgál … Ez egy megjegyzésben lévő XML-címkék segítségével történik. Ezeket a megjegyzéseket külön XML dokumentációs fájl létrehozására használják.
Ha még nem ismeri az XML-t, olvassa el a Mi az XML?
3. példa: XML dokumentációs megjegyzés használata
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
A fenti programban használt XML megjegyzés:
/// /// Ez egy hello world program. ///
A létrehozott XML dokumentáció (.xml fájl) a következőket tartalmazza:
Helló Világ
Látogasson el az XML dokumentációs megjegyzésekbe, ha további információkra kíváncsi.
Használja a Megjegyzések a helyes utat
A megjegyzéseket a kód egyes részeinek magyarázatára használják, de nem szabad őket túlzottan használni.
Például:
// A Hello World Console.WriteLine ("Hello World") nyomtatása;
A fenti példában a megjegyzés használata nem szükséges. Nyilvánvaló, hogy a vonal kinyomtatja a Hello World-t. Ilyen esetekben kerülni kell a megjegyzéseket.
- Ehelyett megjegyzéseket kell használni a programban az összetett algoritmusok és technikák magyarázatához.
- A megjegyzéseknek rövidnek és lényegre törőnek kell lenniük hosszú leírás helyett.
- Alapszabályként jobb , ha kommentek segítségével elmagyarázzuk, miért, ahelyett, hogy hogyan .
