Σε αυτό το άρθρο, θα μάθουμε για C # σχόλια, διαφορετικό στυλ σχολίων και γιατί και πώς να τα χρησιμοποιήσουμε σε ένα πρόγραμμα.
Τα σχόλια χρησιμοποιούνται σε ένα πρόγραμμα για να μας βοηθήσουν να κατανοήσουμε ένα κομμάτι κώδικα. Είναι ανθρώπινες αναγνώσιμες λέξεις που προορίζονται να κάνουν τον κώδικα αναγνώσιμο. Τα σχόλια αγνοούνται εντελώς από τον μεταγλωττιστή.
Στο C #, υπάρχουν 3 τύποι σχολίων:
- Σχόλια μιας γραμμής (
//) - Σχόλια πολλαπλών γραμμών (
/* */) - Σχόλια XML (
///)
Σχόλια μιας γραμμής
Τα σχόλια μιας γραμμής ξεκινούν με διπλή κάθετο //. Ο μεταγλωττιστής αγνοεί τα πάντα μετά //από το τέλος της γραμμής. Για παράδειγμα,
int a = 5 + 7; // Προσθήκη 5 και 7
Εδώ Adding 5 and 7είναι το σχόλιο.
Παράδειγμα 1: Χρήση σχολίου μίας γραμμής
// 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!"); ) ) )
Το παραπάνω πρόγραμμα περιέχει 3 σχόλια μιας γραμμής:
// Hello World Program // Η εκτέλεση ξεκινά από την κύρια μέθοδο
και
// Εκτυπώσεις Hello World
Τα σχόλια μιας γραμμής μπορούν να γραφτούν σε ξεχωριστή γραμμή ή μαζί με τους κωδικούς στην ίδια γραμμή. Ωστόσο, συνιστάται η χρήση σχολίων σε ξεχωριστή γραμμή.
Σχόλια πολλαπλών γραμμών
Τα σχόλια πολλαπλών γραμμών ξεκινούν με /*και τελειώνουν με */. Τα σχόλια πολλαπλών γραμμών μπορούν να εκτείνονται σε πολλές γραμμές.
Παράδειγμα 2: Χρήση σχολίων πολλαπλών γραμμών
/* 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!"); ) ) )
Το παραπάνω πρόγραμμα περιέχει 2 σχόλια πολλαπλών γραμμών:
/ * Αυτό είναι ένα πρόγραμμα Hello World στο C #. Αυτό το πρόγραμμα εκτυπώνει το Hello World. * /
και
/ * Εκτυπώσεις Hello World * /
Εδώ, μπορεί να έχουμε παρατηρήσει ότι δεν είναι υποχρεωτικό ένα σχόλιο πολλαπλών γραμμών να καλύπτει πολλές γραμμές. /*… */μπορεί να χρησιμοποιηθεί αντί για σχόλια μίας γραμμής.
Σχόλια τεκμηρίωσης XML
Το σχόλιο τεκμηρίωσης XML είναι μια ειδική δυνατότητα στο C #. Ξεκινά με τριπλή κάθετο ///και χρησιμοποιείται για να περιγράψει κατηγορηματικά ένα κομμάτι κώδικα… Αυτό γίνεται χρησιμοποιώντας ετικέτες XML μέσα σε ένα σχόλιο. Αυτά τα σχόλια, στη συνέχεια, χρησιμοποιούνται για τη δημιουργία ενός ξεχωριστού αρχείου τεκμηρίωσης XML.
Εάν δεν είστε εξοικειωμένοι με το XML, δείτε Τι είναι το XML;
Παράδειγμα 3: Χρήση σχολίου τεκμηρίωσης XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Το σχόλιο XML που χρησιμοποιείται στο παραπάνω πρόγραμμα είναι
/// /// Πρόκειται για ένα γεια κόσμο. ///
Η τεκμηρίωση XML (αρχείο .xml) που δημιουργείται θα περιέχει:
Γειά σου Κόσμε
Επισκεφτείτε τα σχόλια τεκμηρίωσης XML εάν ενδιαφέρεστε να μάθετε περισσότερα.
Χρησιμοποιήστε σχόλια με τον σωστό τρόπο
Τα σχόλια χρησιμοποιούνται για να εξηγήσουν τμήματα του κώδικα, αλλά δεν πρέπει να χρησιμοποιούνται υπερβολικά.
Για παράδειγμα:
// Εκτυπώσεις Hello World Console.WriteLine ("Hello World");
Η χρήση σχολίου στο παραπάνω παράδειγμα δεν είναι απαραίτητη. Είναι προφανές ότι η γραμμή θα τυπώσει το Hello World. Τα σχόλια πρέπει να αποφεύγονται σε τέτοιες περιπτώσεις.
- Αντ 'αυτού, τα σχόλια πρέπει να χρησιμοποιούνται στο πρόγραμμα για την εξήγηση πολύπλοκων αλγορίθμων και τεχνικών.
- Τα σχόλια πρέπει να είναι σύντομα και στο σημείο αντί για μια μακρά περιγραφή.
- Κατά κανόνα, είναι καλύτερα να εξηγήσετε γιατί αντί για το πώς , χρησιμοποιώντας σχόλια.
