Generics trong vấn đề tài liệu XML

Question

Tôi đang cố gắng bao gồm một đoạn mã trong tài liệu XML lớp của tôi nhưng trình biên dịch phàn nàn rằng một phần tử xml không bị đóng! Đây là những gì tôi đang cố gắng để đạt được

/// <summary> 
/// Method documentation here... 
/// </summary> 
/// <remarks> 
/// <para> 
/// This class should be used as follow: 
/// <br/> 
/// ************** PROBLEM IN NEXT LINE ******************** 
/// <c> MyClass class = new MyClass<String>(); </c> 
/// </para> 
/// </remarks> 
public class MyClass<T>{ 
.... 
} 

Tôi cố gắng để thay thế các đoạn mã bằng /// <c> MyClass class = new MyClass{String}(); </c>

Bất kỳ ai đã có kinh nghiệm này trước đây chưa?

Nhờ sự giúp đỡ của bạn

Answer 1

Trong tài liệu xml, bạn phải thay thế niềng răng hình tam giác với dấu ngoặc nhọn:

/// <summary> 
/// Calls <see cref="DoSomething{T}"/>. 
/// </summary> 
public void CallsDoSomething() 
{ 

} 

public void DoSomething<T>() 
{ 

} 

Lý do bạn kết thúc buộc phải làm điều này, nó bởi vì nó thực sự isn' t cũng được hình thành xml nếu bạn cho phép niềng răng hình tam giác bên ngoài đánh dấu phần tử.

Thay thế bạn đã thử là chính xác.

Answer 2

<remarks> của bạn không bao giờ bị đóng.

Thay thế các dấu ngoặc nhọn như bạn đã thử cũng là cần thiết.

Answer 3

Bạn không đóng thành phần Remarks trong dòng thứ 4, có thể bạn đang phàn nàn về điều đó, chỉ ở số dòng sai.

Ngoài ra, với các ví dụ có chứa generics, nó chọn lên List<string> làm văn bản theo ngữ nghĩa List theo sau là một phần tử XML không rõ ràng string. Cách dễ nhất xung quanh việc này là làm List <string&gr; khi được phân tích cú pháp tạo ra List<string> mà không phải là một phần tử XML.

C# đội biên dịch thêm { và } như thay thế cho điều đó, vì vậy bạn chỉ có thể làm List{string} và nó sẽ được chế biến thành <> 's.

Answer 4

Một vài điều:

1. thoát < và > của bạn ký tự bằng cách thay thế chúng với < và >.
2. Đóng XML của bạn <remarks> phần với một </remarks>
3. Khi bạn đã quyết định tham khảo một chung trong một thẻ (ví dụ: <see ... />, <seealso ... />, vv) sau đó bạn sẽ làm như vậy giống như sau: <see cref="SomeMethod{T}(T value)" />. Không bao giờ chỉ định một loại cụ thể trong tham chiếu (nghĩa là, đừng làm <see cref="SomeMethod{String}(String value)" />).

Đây là một phiên bản cố định của XML của bạn Bình luận:

/// <summary> 
/// Method documentation here... 
/// </summary> 
/// <remarks> 
/// <note type="implementsinfo"> 
///  <para>This class should be used as follow:</para> 
///  <para><c>MyClass class = new MyClass&lt;string&lt;();</c></para> 
/// </note> 
/// </remarks> 
public class MyClass<T> 
{ 
    .... 
}