Làm cách nào để thoát các ký tự trong các nhận xét c #?

Hôm nay tôi nhận ra rằng tôi không biết làm thế nào để thoát các ký tự trong nhận xét cho C #. Tôi muốn ghi lại một lớp C # chung, nhưng tôi không thể viết một ví dụ thích hợp vì tôi không biết cách thoát ký tự <và >. Tôi có phải sử dụng <và >? Tôi không thích nếu đó là trường hợp vì tôi muốn giúp dễ dàng đọc nhận xét trong tài liệu thực tế, vì vậy tôi không phải tạo một số loại tài liệu mã để có thể đọc mã ví dụ.

Nếu bạn cần phải thoát khỏi nhân vật trong ý kiến XML, bạn cần phải sử dụng các đối tượng nhân vật, vì vậy <sẽ cần phải được thoát như <, như trong câu hỏi của bạn.

Cách thay thế để thoát là sử dụng CDATAcác phần, cho hiệu quả tương tự.

Như bạn đã lưu ý, điều này sẽ tạo ra tài liệu đẹp, nhưng một nhận xét khủng khiếp khi đọc ...

Trong các nhận xét C # thuần túy, bạn có thể sử dụng bất kỳ ký tự nào (trừ */khi bạn bắt đầu nhận xét bằng /*hoặc ký tự dòng mới nếu bạn bắt đầu nhận xét bằng //). Nếu bạn đang sử dụng nhận xét XML thì bạn có thể sử dụng phần CDATA để bao gồm các ký tự '<' và '>'.

Xem bài viết blog MSDN này để biết thêm thông tin về các nhận xét XML trong C #.

Ví dụ

/// <summary>
/// Here is how to use the class: <![CDATA[ <test>Data</test> ]]>
/// </summary>

Bạn nói "Tôi muốn làm cho nó dễ dàng để đọc nhận xét trong tài liệu thực tế". Tôi đồng ý.

Các nhà phát triển dành phần lớn cuộc đời của họ trong mã , không xem xét các tài liệu được tạo tự động. Những thứ đó rất tốt cho các thư viện của bên thứ ba như lập biểu đồ, nhưng không tốt cho việc phát triển nội bộ nơi chúng tôi làm việc với tất cả mã. Tôi thực sự bị sốc khi MSFT không đưa ra giải pháp hỗ trợ các nhà phát triển tốt hơn ở đây. Chúng tôi có các vùng mã mở rộng / thu gọn động ... tại sao chúng tôi không thể có nút chuyển đổi hiển thị nhận xét tại chỗ (giữa văn bản thô và nhận xét XML đã xử lý hoặc giữa văn bản thô và nhận xét HTML đã xử lý) ?. Có vẻ như tôi nên có một số khả năng HTML cơ bản trong các nhận xét mở đầu phương thức / lớp của mình (văn bản màu đỏ, chữ in nghiêng, v.v.). Chắc chắn một IDE có thể hoạt động một chút phép thuật xử lý HTML để làm sống động các nhận xét nội tuyến.

Giải pháp hack-of-a-solution của tôi: Tôi thay đổi '<' thành "{" và '> "thành"} ". Điều đó dường như che đậy tôi đối với nhận xét về phong cách sử dụng ví dụ điển hình, bao gồm cả ví dụ cụ thể của bạn. Không hoàn hảo, nhưng thực dụng đưa ra vấn đề về khả năng đọc (và vấn đề với màu nhận xét IDE xảy ra khi sử dụng '<')

Nhận xét XML của C # được viết bằng XML, vì vậy bạn sẽ sử dụng cách thoát XML bình thường.

Ví dụ...

<summary>Here is an escaped &lt;token&gt;</summary>

Tôi đã tìm thấy một giải pháp khả thi cho vấn đề này chỉ đơn giản là bao gồm hai ví dụ: một phiên bản khó đọc trong các ký tự w / Escape chú thích XML và một phiên bản khác có thể đọc được bằng cách sử dụng các //chú thích thông thường .

Đơn giản mà hiệu quả.

Tốt hơn là sử dụng {...} là sử dụng ≤ ... ≥ (dấu nhỏ hơn hoặc bằng, dấu lớn hơn hoặc bằng, U2264 và U2265 trong Unicode). Trông giống như dấu ngoặc nhọn được gạch dưới nhưng vẫn chắc chắn là dấu ngoặc nhọn! Và chỉ thêm một vài byte vào tệp mã của bạn.

Tốt hơn hãy thử U2280 và U2281 - chỉ cần sao chép và dán từ Danh sách các ký tự Unicode (phần toán tử toán học).