Cách sử dụng chú thích trong C#

CÁCH SỬ DỤNG CHÚ THÍCH TRONG C#
16/07/2007 10:21 AM
Trước khi có sự ra đời của Dot Net, trong các ngôn ngữ lập
trình đều sử dụng những "Chú Thích" như là một cách để làm rõ
ràng cho các khối lệnh của chương trình. Nhưng bây giờ, với sự
ra đời của Dot Net Frameworks, thì dựa vào những "Chú Thích",
bạn có thể tạo ra những tài liệu ứng dụng mà bạn đang phát
triển.
Có 2 loại "Chú Thích" sử dụng với .NET FrameWorks. Loại thông
thường nhất là các loại "Chú Thích Dòng" (Bất cứ khi nào bạn sử
dụng // với C# hoặc VB.NET để đánh dấu một dòng là Chú Thích.)
Loại chú thích này thường được sử dụng để giải thích những gì mà
dòng lệnh hiện hành hoặc dòng mã kế tiếp đang thực hiện. Còn loại
chú thích thứ 2 chính là chú thích XML. Chú thích này ghi chép tài
liệu cho một lớp hoặc phương thức bằng cách sử dụng một phần
XML. Ngoài ra, nó còn tạo tài liệu API cho ứng dụng. Sau đây là một
ví dụ về các chú thích XML được áp dụng và một phương thức C#.=:
/// <summary>
/// This method can spilit a String.
/// </summary>
/// <param name="words"></param>
/// <param name="ar"></param>
private static void SplitString(string words, ref ArrayList ar)
{
...
}
Trong phần này, Tôi chỉ nói về chú thích XML trong C#. Như ta đã
thấy trong ví dụ trên, các chú thích XML rất đơn giản - đặt /// trước
các lớp, giao diện, phương thức , trường hoặc trước phần khai báo
thuộc tính. Visual Studio sẽ tự động tổng kết cơ bản về hàm hoặc
phương thức cùng với các tham số đi kèm. Có hơn 20 loại thẻ khác

nhau có thể được sử dụng trong các chú thich XML, và được chia
làm 2 loại chính.
I. Các Thẻ Chính:
Các Thẻ chính là những thẻ mà bạn sử dụng một cách độc
lập với những thẻ khác.
1. <summary>:
Vì nó xuất hiện theo thẻ mặc định, nên có thể nó là thẻ quen
nhất trong các loại thẻ. Nó nên được sử dụng để ghi chép mục đích
chung nhất của tất cả các phương thức public, thuộc tính và trường
của một kiểu.
/// <summary>
/// Hàm Đánh dấu một kí tự.
/// </summary>
private string MarkKeyword
{
.......
}
2. <remarks>:
Thẻ này có ý nghĩa là mô tả một kiểu. Có thể bạn không biết
điều này bời vì khi chèn các chú thích XML và trong Visual Studio, nó
sẽ chèn thẻ <summary> thay vì chèn thẻ <remarks>. Sự khác biệt
không lớn nhưng tài liệu C# đề nghị sử dụng <remarks>. Sau đây là
ví dụ về thẻ remarks:
/// <remarks>
/// Hàm Đánh dấu một kí tự.
/// </remarks>
private string MarkKeyword
{
........
}

3. <value>:
Tương tự như 2 thẻ trên, thẻ <value > mô tả giá trị của một
thuộc tính. Nó cũng được sử dụng như các thẻ khác:
/// <value>
/// Thuộc tính này số lượng các sách có trong thư viện.
/// </value>
protected int numberOfBooks;
4. <param>:
Thẻ <param> được sử dụng để ghi chép từng tham số của
một phương thức. Đây là một trong những chú thích hữu dụng nhát
bởi vì đôi khi khó nhận biết mục đích của một tham số chỉ từ tên của
nó.
/// <summary>
/// Hàm này để chia một ArrayList thành chuỗi string.
/// </summary>
/// <param name="words"></param>
/// <param name="ar">một danh sách các chủ đề của bài
viết.</param>
private static void SplitString(string words, ref ArrayList ar)
{
..........
}
5. <returns> :
Thẻ này được sử dụng để định nghĩa kiểu trả về của một
phương thức. Từ chữ ký của phương thức, bạn biết kiểu nào nó trả
về. Do đ, việc khai báo kiểu giá trị cho nó là vô ích mà hãy giải thích
những gì mà giá trị trả về đó.
/// <summary>
/// Thay thế các ký tự đặc biệt bằng dấu cách
/// </summary>

/// <param name="s"></param>
/// <returns>Giá trị trả lại là những dấu cách</returns>
private static string ReplaceSpecialChar(string s)
{
string specialChar = @"'-%*";// Chuỗi ký tự đặc biệt
........
return s;
}
6. <exception> :
Được sử dụng để xác định các ngoại lệ mà một kiểu có thể
đưa ra. Thẻ này sử dụng một thuộc tính được gọi là cref. Thuộc tính
craf được sử dụng để tham chiếu một kiểu khác. Bằng cách sử dụng
thẻ <exception>, bạn nên ghi chép tất cả những ngoại lệ cụ thể mà
phương thức có thể đưa ra bằng thuộc tính cref và sau đó giải thích
khi nào ngoại lệ có thể được đưa ra.
/// <exception cref="Exception">
/// Có lỗi trong quá trình xử lý
/// </exception>
void Page_LoadComplete(object sender, EventArgs e)
{
........
}
Vậy biết những ngoại lệ nào mà một phương thức có thể đưa ra rất
quan trọng đối với việc phát triển các ứng dụng chất lượng cao. Vì
.NET không cho bạn xác định những ngoại lệ nào mà phương thức
có thể đưa ra trong chữ ký phương thức.
7.<example> :
Với thẻ này, có thể được sử dụng để cung cấp một ví dụ về
cách sử dụng phương thức, thuộc tính hoặc trường. các ví dụ là một
phần chính của việc ghi chép tài liệu chất lượng cao và không có gì

có thể hướng dẫn tốt hơn cho các nhà phát triển cách làm việc với
các kiểu của bạn. Bằng cách sử dụng thẻ <example> cùng với thẻ