C# XML документация: как создавать заметки?

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

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

Источник

2 ответа

Решение
/// <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 / Visual Basic Note
  • cs / CSharp / C# / C# / visual C# note
  • cpp / C++/C++/CPP/visual C++ note
  • JSharp / j # / J # / visual j # note
  • воплощать в жизнь
  • гость
  • унаследовать
Источник

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

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

Источник
Другие вопросы по тегам