Trong bài viết này, chúng ta sẽ tìm hiểu về các bình luận C #, các kiểu bình luận khác nhau, tại sao và cách sử dụng chúng trong một chương trình.
Nhận xét được sử dụng trong một chương trình để giúp chúng tôi hiểu một đoạn mã. Chúng là những từ có thể đọc được của con người nhằm mục đích làm cho mã có thể đọc được. Nhận xét hoàn toàn bị bỏ qua bởi trình biên dịch.
Trong C #, có 3 loại chú thích:
- Nhận xét dòng đơn (
//) - Nhận xét nhiều dòng (
/* */) - Nhận xét XML (
///)
Nhận xét dòng đơn
Nhận xét dòng đơn bắt đầu bằng dấu gạch chéo kép //. Trình biên dịch bỏ qua mọi thứ sau khi //đến cuối dòng. Ví dụ,
int a = 5 + 7; // Thêm 5 và 7
Đây, Adding 5 and 7là bình luận.
Ví dụ 1: Sử dụng chú thích một dòng
// 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!"); ) ) )
Chương trình trên có 3 dòng chú thích:
// Chương trình Hello World // Bắt đầu thực thi từ phương thức Main
và
// In Hello World
Nhận xét dòng đơn có thể được viết trong một dòng riêng biệt hoặc cùng với các mã trong cùng một dòng. Tuy nhiên, nên sử dụng các bình luận trong một dòng riêng biệt.
Nhận xét nhiều dòng
Nhận xét nhiều dòng bắt đầu bằng /*và kết thúc bằng */. Nhận xét nhiều dòng có thể kéo dài trên nhiều dòng.
Ví dụ 2: Sử dụng bình luận nhiều dòng
/* 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!"); ) ) )
Chương trình trên có 2 dòng chú thích:
/ * Đây là chương trình Hello World bằng C #. Chương trình này in Hello World. * /
và
/ * Bản in Hello World * /
Ở đây, chúng ta có thể nhận thấy rằng không bắt buộc một bình luận nhiều dòng phải trải dài trên nhiều dòng. /*… */có thể được sử dụng thay cho các bình luận dòng đơn.
Nhận xét về Tài liệu XML
Chú thích tài liệu XML là một tính năng đặc biệt trong C #. Nó bắt đầu bằng dấu gạch chéo ba ///và được sử dụng để mô tả phân loại một đoạn mã… Điều này được thực hiện bằng cách sử dụng các thẻ XML trong một nhận xét. Sau đó, những nhận xét này được sử dụng để tạo một tệp tài liệu XML riêng.
Nếu bạn chưa quen với XML, hãy xem XML là gì?
Ví dụ 3: Sử dụng chú thích tài liệu XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Nhận xét XML được sử dụng trong chương trình trên là
/// /// Đây là chương trình chào thế giới. ///
Tài liệu XML (tệp .xml) được tạo sẽ chứa:
Chào thế giới
Truy cập Nhận xét của Tài liệu XML nếu bạn muốn tìm hiểu thêm.
Sử dụng Nhận xét đúng cách
Nhận xét được sử dụng để giải thích các phần của mã nhưng không nên lạm dụng chúng.
Ví dụ:
// In Hello World Console.WriteLine ("Hello World");
Sử dụng bình luận trong ví dụ trên là không cần thiết. Rõ ràng là dòng sẽ in Hello World. Cần tránh bình luận trong những trường hợp như vậy.
- Thay vào đó, các chú thích nên được sử dụng trong chương trình để giải thích các thuật toán và kỹ thuật phức tạp.
- Nhận xét nên ngắn gọn và đi vào trọng tâm thay vì mô tả dài.
- Theo quy tắc chung, tốt hơn là giải thích lý do tại sao thay vì cách sử dụng các nhận xét.
