Документация С# xml: как создавать заметки?

Я хочу получить аналогичную вещь с желтым полем "Примечание:" в разделе примечаний на этой странице MSDN в моей собственной документации,

Я использую sandcastle и строительный файл справки sandcastle для создания ссылочного сайта из тегов документации. Что мне нужно написать для создания такого окна примечаний?

ОТВЕТЫ

Ответ 1

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

Посмотрите файл "C:\Program Files\Sandcastle\Examples\Sandcastle\test.cs"

Тип может быть одним из:

  • примечание
  • кончик
  • осторожность
  • Безопасность
  • важно
  • vb/VB/VisualBasic/визуальная базовая заметка
  • cs/CSharp/С#/С#/visual С# note
  • cpp/С++/С++/CPP/visual С++ note
  • JSharp/j #/J #/visual j # note
  • реализации
  • абонент
  • наследует

Ответ 2

Не прямое решение, а альтернатива:

NDoc поддерживает тег <note>. Поскольку NDoc устарел, вы можете найти эту функцию в NDoc3, которую, безусловно, стоит посмотреть, так как она также способна создавая обычную HTML-документацию, а не только онлайн-документацию, которая предполагает asp.net.