2011-07-20 54 views
11

Tôi muốn đạt được điều tương tự với hộp 'Ghi chú:' màu vàng trong phần nhận xét trên this MSDN page trong tài liệu của riêng tôi.Tài liệu C# xml: Cách tạo Ghi chú?

Tôi đang sử dụng lâu đài cát và người xây dựng tệp trợ giúp lâu đài cát để tạo trang web tham chiếu trong số các thẻ tài liệu. Tôi phải viết gì để đạt được một hộp ghi chú như vậy?

Trả lời

13
/// <summary><c>Increment</c> method increments the stored number by one. 
/// <note type="caution"> 
/// note description here 
/// </note> 
/// </summary> 

Nhìn vào tập tin "C: \ Program Files \ Sandcastle \ ví dụ \ Sandcastle \ Test.cs"

Loại có thể là một trong số:

  • lưu ý
  • mũi
  • thận trọng
  • bảo mật
  • quan trọng
  • vb/VB/VisualBasic/hình ảnh lưu ý cơ bản
  • cs/CSharp/C#/C#/Visual C# lưu ý
  • cpp/C++/C++/CPP/Visual C++ lưu ý
  • JSharp/j #/J #/hình ảnh j lưu ý
  • # thực hiện
  • gọi
  • kế thừa
+0

Tuyệt. Điều đó chỉ hoạt động! Không tìm thấy thẻ trong danh sách 'chính thức', nhưng tốt để biết rằng thẻ NDoc cũng được hỗ trợ. –

+0

Có. Nó không được hỗ trợ chính thức, nhưng SandCastle được lấy cảm hứng chính xác với NDoc: http://blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – chopikadze

+0

THX, +1 từ tôi. Chỉ cần một lưu ý phụ: Tôi nghĩ bạn thường không nên bao gồm s trong phần

. phải phù hợp hơn. –

0

Không phải là một giải pháp trực tiếp, nhưng một sự thay thế:

NDoc hỗ trợ Tag <note>. Vì NDoc đã lỗi thời, bạn có thể tìm kiếm tính năng này trong NDoc3, điều chắc chắn đáng xem vì nó cũng có khả năng tạo tài liệu HTML thuần túy, không chỉ tài liệu trực tuyến giả định asp.net.

+0

Cảm ơn, nhưng cơ sở hạ tầng của chúng tôi đã dựa vào SC và không thể thay đổi điều đó một cách dễ dàng. –

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