Download miễn phí Cách sử dụng chú thích trong C#



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à cách 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.


http://s1.liketly.com/flash/edoc/jh2i1fkjb33wa7b577g9lou48iyvfkz6-swf-2014-02-25-cach_su_dung_chu_thich_trong_c.bQJOtJkbBj.swf /tai-lieu/de-tai-ung-dung-tren-liketly-59050/
Để tải bản Đầy Đủ của tài liệu, xin Trả lời bài viết này, Mods sẽ gửi Link download cho bạn sớm nhất qua hòm tin nhắn.
Ai cần download tài liệu gì mà không tìm thấy ở đây, thì đăng yêu cầu down tại đây nhé:
Nhận download tài liệu miễn phí

Tóm tắt nội dung tài liệu:

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#
hay 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 hay
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 hay cách 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
cách C#.=:
///
/// This method can spilit a String.
///
///
///
private static void SplitString(string words, ref ArrayList ar)
{
...
}
Trong phần này, tui 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, cách , trường hay 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 hay cách 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. :
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 cách 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ệt khô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ột thuộ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ủa một
cách. Đâ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ó.
///
/// 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ương
thức. Từ chữ ký của cách, 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ề đó.
///
/// 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ách
private 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ạn
nên ghi chép tất cả những ngoại lệ cụ thể mà cách 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.
///
/// 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 cách 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à cách có thể đưa ra trong
chữ ký cách.
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 cách, thuộc tính hay 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ẻ 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, ' ');
///
///
///
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ập kiểu của bạn. Thẻ
cũng có thể chứa thuộc tính cref và hầu như luôn hướng sang
System.Security.PermissionSer.
///
/// Tạo chuỗi tìm kiếm từ một danh sách các từ khóa cần tìm
///
///
///
///
///
///
/// Private Access
///
///
private static string BuildSQLQuery(string fieldName, ArrayList keywords)
9. :
Có thể được sử dụng để tham chiếu các lớp khác hay những tài liệu
vốn có để gây sự chú ý với người đọc tài liệu. Thẻ này cũng có chứa thuộc
tính cref và bạn có thể tham chiếu các kiểu, cách, thuộc tính hay
trường khác mà người dùng có thể quan tâm đến.
///
/// Tạo chuỗi tìm kiếm từ một danh sách các từ khóa cần tìm
///
///
///
///
///
private static string BuildSQLQuery(string fieldName, ArrayList keywords)
10. :
Thẻ này khác với các thẻ chính khác bởi vì nó được sử dụng để bao
hàm các chú thích XML bên ngoài trái với việc ghi chép tài liệu cho bất cứ
thứ gì. Thẻ có thể hữu dụng nếu các chú thích XML trong các file
nguồn ngày càng trở nên lớn và vụng về. Để sử dụng thẻ này, bạn sẽ cần
phải sử dụng tên file cũng như biểu thức XPath vốn sẽ được sử dụng để đi
đến các chú thích của bạn.
/// <include file='XMLLib.xml'
/// path='doc/members/member[@name="M:XMLLib.Vehicle.Start"]'/>
public virtual void Start()
II. Các thẻ thứ cấp:
Có thể được sử dụng bên trong các thẻ chính. Những thẻ này được sử
dụng để đánh dấu và định dạng Text để đưa vào các thẻ chính. Trong ví dụ
về thẻ ta cũng đã biết được thẻ rồi.
1. Nhập và :
Các thẻ và đều được sử dụng định nghĩa khi nào một
phần Text là mã. Sự khác biệt duy nhất giữa 2 thẻ này là có thể được sử
dụng để đánh dấu một điều gì đó là mã nội dòng (jnline) trong một câu khác,
trong khi được sử dụng để xác lập toàn bộ một khối Text dưới dạng
mã. Có nghĩa là có chứa các ngắt dòng còn thì không.
///
/// Thay thế các ký tự đặc biệt bằng dấu cách bằng hàm
ReplaceSpecialChar("a")
///
///
///
private static string ReplaceSpecialChar(...

---

Yêu cầu Download