CÁCH SỬ DỤNG DÙNG CHO CHÚ THÍCH TRONG C#

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
Nội dung trích xuất từ tài liệu:
CÁCH SỬ DỤNG DÙNG CHO CHÚ THÍCH TRONG C#CÁCH Sử DụNG CHÚ THÍCH TRONG C# 16/07/2007 10:21 AMTrướ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ốilệnh của chương trình. Nhưng bây giờ, với sự ra đời của Dot NetFrameworks, thì dựa vào những Chú Thích, bạn có thể tạo ra nhữngtà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ườngnhấ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àythường được sử dụng để giải thích những gì mà dòng lệnh hiện hành hoặcdòng mã kế tiếp đang thực hiện. Còn loại chú thích thứ 2 chính là chú thíchXML. Chú thích này ghi chép tài liệu cho một lớp hoặc phương thức bằngcách sử dụng một phần XML. Ngoài ra, nó còn tạo tài liệu API cho ứngdụng. Sau đây là một ví dụ về các chú thích XML được áp dụng và mộtphương thức C#.=:/// /// This method can spilit a String./// /// /// 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ấytrong 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. VisualStudio sẽ tự động tổng kết cơ bản về hàm hoặc phương thức cùng với cáctham số đi kèm. Có hơn 20 loại thẻ khác nhau có thể được sử dụng trongcá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ớinhững thẻ khác.1. : Vì nó xuất hiện theo thẻ mặc định, nên có thể nó là thẻ quen nhấttrong các loại thẻ. Nó nên được sử dụng để ghi chép mục đích chung nhấtcủa tất cả các phương thức public, thuộc tính và trường của một kiểu./// /// Hàm Đánh dấu một kí tự./// private string MarkKeyword{.......}2. : Thẻ này có ý nghĩa là mô tả một kiểu. Có thể bạn không biết điềunày bời vì khi chèn các chú thích XML và trong Visual Studio, nó sẽ chènthẻ thay vì chèn thẻ . Sự khác biệt không lớn nhưngtài liệu C# đề nghị sử dụng . Sau đây là ví dụ về thẻ remarks:/// /// Hàm Đánh dấu một kí tự./// private string MarkKeyword{........}3. : Tương tự như 2 thẻ trên, thẻ mô tả giá trị của một thuộctính. Nó cũng được sử dụng như các thẻ khác:/// /// Thuộc tính này số lượng các sách có trong thư viện./// protected int numberOfBooks;4. : Thẻ được sử dụng để ghi chép từng tham số của mộtphương thức. Đây là một trong những chú thích hữu dụng nhát bởi vì đôikhi khó nhận biết mục đích của một tham số chỉ từ tên của nó./// /// Hàm này để chia một ArrayList thành chuỗi string./// /// /// một danh sách các chủ đề của bài viết.private static void SplitString(string words, ref ArrayList ar){..........}5. : Thẻ này được sử dụng để định nghĩa kiểu trả về của một phươngthức. Từ chữ ký của phương thức, bạn biết kiểu nào nó trả về. Do đ, việckhai 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ề đó./// /// Thay thế các ký tự đặc biệt bằng dấu cách/// /// /// Giá trị trả lại là những dấu cáchprivate static string ReplaceSpecialChar(string s){string specialChar = @-%*;// Chuỗi ký tự đặc biệt........return s;}6. : Đượ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ẻ , bạnnên ghi chép tất cả những ngoại lệ cụ thể mà phương thức có thể đưa ra bằngthuộc tính cref và sau đó giải thích khi nào ngoại lệ có thể được đưa ra./// /// Có lỗi trong quá trình xử lý/// 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 quantrọng đối với việc phát triển các ứng dụng chất lượng cao. Vì .NET khôngcho bạn xác định những ngoại lệ nào mà phương thức có thể đưa ra trongchữ ký phương thức.7. : 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ủaviệ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ốthơ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ẻ cùng với thẻ (một trong những thẻ thứ cấp),bạn có thể cung cấp trực tiếp các vi dụ mã trong mã của bạn./// /// Thay thế các ký tự đặc biệt bằng dấu cách/// /// /// /// /// ////// // Chuỗi ký tự đặc biệt////// string specialChar = @-%*;////// // gán các ký tự đặc biệt thành ký tự rỗng.////// s = s.Replace(specialChar[i], );////// /// private static string ReplaceSpecialChar(string s)Bạn nghĩ sao nếu tài liệu MSDN không có các ví dụ. đó chính mà ví dụcho sự quan trọng của thẻ .8. : Cho phép bạn xác định ai đượ ...