Giới thiệu

Bạn đã biết trong mỗi file code, tất các mã phải tuân thủ theo quy tắc cú pháp của ngôn ngữ đó. Việc gõ sai cấu trúc sẽ đem lại vô số lỗi không đáng có. Hơn nữa ngoài việc viết mã trong sáng, sạch sẽ bạn  cũng cần đưa ra chú thích rõ ràng ở một số điểm đáng chú ý. Hay đơn giản bạn muốn người nào đó đọc và hiểu bạn đang làm gì, thì hầu hết các ngôn ngữ lập trình đều hộ trợ chú thích bên trong code. Điều đó không ảnh hưởng tới code của bạn, trình biên dịch sẽ bỏ qua nó . . .

Cách viết chú thích trong C#

Trong C# có 3 kiểu hay được sử dụng và dù là kiểu nào thì chúng đều có dạng màu xanh như nhau.

Kiểu 1. Viết chú thích chỉ trên một dòng

Cấu trúc:

// Comment here: Bắt đầu với hai dấu '/' và chỉ có tác dụng trên một dòng

Kiểu 2. Viết chú thích trên nhiều dòng

Cấu trúc:

/*
  Cặp dấu '/*'  '*/'  tác dụng mở và đóng một đoạn chú thích trên nhiều dòng
*/

Hai kiểu trên có thể dùng mọi nơi trong mã nguồn của bạn. Ví dụ sau cho các bạn thấy 2 hình thức ghi chú nêu trên trong C#

class HelloWorld
{
	static void Main( ) // Đây là ghi trên một dòng
	{
		/* Bắt đầu ghi chú nhiều dòng
		Vẫn còn trong ghi chú Kết thúc ghi chú bằng */ S
		ystem.Console.WriteLine("Hello World");
	}
}

Kiểu 3. Viết chú thích kiểu Documentation cho phương thức và lớp

Loại này có đôi chút khác biệt, nó bắt đầu với 3 dấu ‘/’ và nó thường được sử dụng để ghi chú, giải nghĩa cho một phương thức hoặc lớp.

Cấu trúc:
Sau khi bạn viết một phương thức hoặc lớp, đặt con trỏ chuột lên trước một dòng và gõ ‘///’ 3 lần VS Studio sẽ tự generate ra cho bạn. Như hình dưới đây

Cách sử dụng chú thích
+ Kiểu chú thích trên một hoặc nhiều dòng, có thể được dùng khắp mã nguồn.

+ Kiểu chú thích documentation  thì thường được dùng để mô tả đặc tính của class, phương thức. Và thông thường khi gõ ‘///’ trên mỗi phương thức và class Visual studio tự generate cho bạn đầy đủ documment, bạn có thể thêm thẻ tag để bổ sung mô tả.

+ Trong quá trình code đôi khi ta cần vô hiệu hóa một khoản code ngắn hay dài, cách đơn giản và nhanh nhất là chuyển về dạng chú thích. Bằng cách bôi đen đoạn code của bạn và nhấn tổ hợp phím Ctrl + K + C Và để hoàn lại thao tác này ta lại nhấn Ctrl + K + U.

Kết luận

Hãy thực hành viết ứng dụng riêng bạn và sử dụng các kiểu chú thích như trên nhé. Chúc các bạn lập trình tốt. Hãy thường xuyên theo dõi website csharpcanban.com để cập nhật các bài học mới nhé các bạn.

Bản quyền

Nội dung trên csharpcanban.com được biên soạn, biên dịch từ nhiều nguồn khác nhau, đồng thời đã được viết thành chương trình chạy. Csharpcanban.Com bảo lưu mọi quyền đối với những bài viết này. Mọi hình thức sao chép đều cần phải được Csharpcanban.Com cấp phép.