Nhận xét là một chú thích trong mã nguồn với mục đích cung cấp cho lập trình viên một lời giải thích dễ đọc về mã. Các chú thích này bị trình biên dịch bỏ qua khi biên dịch mã của bạn. Nhận xét nên giải thích, ở mức độ trừu tượng cao hơn mã, những gì bạn đang cố gắng thực hiện
C# có cú pháp khác nhau cho nhận xét. Trong hướng dẫn này, chúng tôi sẽ xem xét nhận xét một dòng và nhiều dòng
Ví dụ về chú thích một dòng
Nhận xét một dòng cho phép tường thuật chỉ trên một dòng tại một thời điểm. Nhận xét một dòng có thể bắt đầu ở bất kỳ cột nào của một dòng nhất định và kết thúc ở một dòng mới hoặc xuống dòng
Chuỗi ký tự // đánh dấu văn bản theo sau nó dưới dạng nhận xét một dòng. Đây là một ví dụ
1class Account 2{ 3 private string _accountNo; 4 5 public Account(string accountNo, int balance) 6 { 7 AccountNo = accountNo; 8 Balance = balance; 9 } 10 11 public string AccountNo 12 { 13 get => _accountNo; 14 set 15 { 16 //raise exception if value is null 17 if(String.IsNullOrEmpty(value)) 18 throw new InvalidOperationException(); 19 _accountNo = value; 20 } 21 } 22 23 public int Balance { get; set; } 24 25 public void Credit(int amount) 26 { 27 Balance = amount + Balance; //update the balance with a summation of the inputted amount and the current balance 28 //Logs the new balance to the screen 29 Console.WriteLine(Balance); 30 } 31}
csharp
Mã ở trên sử dụng nhận xét một dòng trong phương thức Credit và bộ truy cập đã đặt cho . property.
Ví dụ chú thích nhiều dòng
Nhận xét nhiều dòng có một hoặc nhiều dòng tường thuật trong một tập hợp các dấu phân cách nhận xét. Dấu phân cách /* đánh dấu phần đầu của nhận xét và dấu */ . Bạn có thể đặt nhận xét của mình trên nhiều dòng và bất kỳ thứ gì nằm giữa các dấu phân cách đó đều được coi là nhận xét
1class Account 2{ 3 /* Account class constructor. 4 In it we initialise the AccountNo and Balance property. 5 These properties are needed to identify an account and perform transaction using its available methods 6 */ 7 public Account(int accountNo, int balance) 8 { 9 AccountNo = accountNo; 10 Balance = balance; 11 } 12 13 public int AccountNo { get; set; } 14 15 public int Balance { get; set; } 16 17 public void Credit(int amount) 18 { 19 Balance = amount + Balance; 20 } 21}
csharp
Nó cũng có thể được đặt bên trong các câu lệnh mã
1var account = new Account(2 /* this is a dummy account number */, 2000);
csharp
Đoạn mã trên cho người đọc biết rằng số 2 chỉ là số tài khoản giả cần được thay thế sau. Hãy cẩn thận với việc sử dụng các bình luận. Nếu một khối mã khó đọc, hãy cố gắng viết lại ở dạng dễ đọc hơn.
Đó là một bọc
Nhận xét mã có thể cực kỳ hữu ích trong việc giúp bạn hoặc các lập trình viên khác, những người sẽ sử dụng mã của bạn, để hiểu mã của bạn tốt hơn. Đó là một cách chú thích mã nguồn với các tường thuật hữu ích. Sử dụng quá mức và bạn nhận được mã nguồn khó đọc và khó hiểu