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

Trước khi có sự ra đời của Dot Net, trong các ngôn ngữ lậptrình đều sử dụng những "Chú Thích" như là một cách để làmrõ ràng cho các khối lệnh của chương trình. Nhưng bây giờ, vớisự 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 đangphát triển.
Nội dung trích xuất từ tài liệu:
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 AMTrước khi có sự ra đời của Dot Net, trong các ngôn ngữ lậptrình đều sử dụng những Chú Thích như là một cách để làmrõ ràng cho các khối lệnh của chương trình. Nhưng bây giờ, vớisự 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 đangphát triển.Có 2 loại Chú Thích sử dụng với .NET FrameWorks. Loại thôngthườ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ạichú thích thứ 2 chính là chú thích XML. Chú thích này ghi chép tàiliệu cho một lớp hoặc phương thức bằng cách sử dụng một phầnXML. Ngoài ra, nó còn tạo tài liệu API cho ứng dụng. Sau đây là mộtví dụ về các chú thích XML được áp dụng và một phươ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ấy trong ví dụ trên, các chú thích XML rất đơn giản - đặt /// trướccác lớp, giao diện, phương thức , trường hoặc trước phần khai báothuộc tính. Visual Studio sẽ tự động tổng kết cơ bản về hàm hoặcphương thức cùng với các tham số đi kèm. Có hơn 20 loại thẻ khácnhau có thể được sử dụng trong các chú thich XML, và được chialà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 độclập với nhữ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ấ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./// /// 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ều này bời vì khi chèn các chú thích XML và trong Visual Studio, nósẽ chèn thẻ thay vì chèn thẻ . Sự khác biệtkhông lớn nhưng tà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ộtthuộc tí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ủamột phương thức. Đây là một trong những chú thích hữu dụng nhátbởi vì đôi khi khó nhận biết mục đích của một tham số chỉ từ tên củanó./// /// Hàm này để chia một ArrayList thành chuỗi string./// /// /// một danh sách các chủ đề của bàiviế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ộtphươ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íchnhữ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ínhcraf được sử dụng để tham chiếu một kiểu khác. Bằng cách sử dụngthẻ , 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íchkhi 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ấtquan 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ươngthức có thể đưa ra trong chữ 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ộtphầ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ớicá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ếpcá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 được phép truy c ...