2010-04-20 28 views
11

Tôi có một phương pháp trong C#/dự án WPF và tôi muốn bình luận/Document nó sử dụng các ý kiến ​​XML như thế nàyVisual Studio XML comments (tóm tắt) và ký tự đặc biệt

/// <summary> 
    /// Initialises Drag & Drop 
    /// </summary> 
    void initDragDrop() 
    { 

    } 

Khi tôi hiện nay sử dụng phương pháp này ở đâu đó trong dự án của tôi và di chuột qua nó, tôi nhận được thông báo "XML nhận xét chứa XML không hợp lệ: Tại nơi này, không có khoảng trống nào được cho phép" (Tôi đã dịch văn bản sau dấu hai chấm theo cách thủ công sang tiếng Anh, vì vậy nó có thể không có nghĩa đen trong studio trực quan của bạn). Tôi phát hiện ra vấn đề là dấu hiệu "&", nếu tôi xóa nó, nó hoạt động tốt. Nhưng tôi muốn giữ nó, vậy làm cách nào để thoát khỏi nó trong bản tóm tắt XML? Tôi đã thử "\ &" nhưng điều này không hoạt động.

Cảm ơn bạn đã gợi ý!

Trả lời

16

Hãy nhớ rằng ký tự & có ý nghĩa đặc biệt trong xml (bắt đầu một thực thể). Bạn cần phải viết bình luận của bạn như thế này để thay thế (khó chịu, tôi biết):

/// <summary> 
/// Initialises Drag &amp; Drop 
/// </summary> 
void initDragDrop() 
{ 

} 

Tôi có thể sai ở điểm tiếp theo này, nhưng tôi không nghĩ rằng bạn thậm chí có thể sử dụng một phần CDATA để tránh các thực thể, bởi vì nó phá vỡ các bình luận. Bạn phải nhập toàn bộ thực thể &amp;.

+1

Thực ra, bạn có thể sử dụng CDATA. Dưới đây là ví dụ từ một trong các dự án của tôi: http://kbcsv.codeplex.com/sourcecontrol/network/Show?projectName=kbcsv&changeSetId=42031#530479. Một tùy chọn khác là di chuyển tài liệu đến một tệp riêng biệt hoàn toàn và nó vào tệp nguồn. –

+0

Cảm ơn, biết rõ. –

+0

cảm ơn cả hai vì đã trả lời! kent, sử dụng liên kết của bạn Tôi đã thấy rằng lớp học của bạn được tài liệu tốt. Tôi đoán bạn đang tạo ra một số kidn của HTML từ này? Bạn đang sử dụng công cụ nào cho tác vụ này? Thời gian qua tôi đã tìm kiếm những công cụ như vậy, tất cả chúng đều dành cho các phiên bản net trước đó hoặc khó sử dụng cho người mới bắt đầu. Tôi sẽ chấp nhận câu trả lời, trước tiên đó là giải pháp ngắn, thứ hai đã thêm giải pháp của anh ấy làm nhận xét không đánh dấu được, nếu không tôi cũng sẽ đánh dấu nó ;-) –

Các vấn đề liên quan