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

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

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


person Sebastian P.R. Gingter    schedule 20.07.2011    source источник


Ответы (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/визуальное базовое примечание
  • cs/CSharp/c#/C#/визуальная примечание C#
  • примечание cpp/С++/С++/CPP/визуальный С++
  • JSharp/j#/J#/визуальная примечание j#
  • воплощать в жизнь
  • абонент
  • наследовать
person chopikadze    schedule 20.07.2011
comment
Прохладный. Это просто работает! Не нашел тег в «официальном» списке, но приятно знать, что также поддерживаются теги NDoc. - person Sebastian P.R. Gingter; 20.07.2011
comment
да. Официально он не поддерживается, но SandCastle был вдохновлен именно NDoc: blogs.msdn.com/b/sandcastle/archive/2006/11/22/ - person chopikadze; 20.07.2011
comment
THX, +1 от меня. Просто примечание: я думаю, что вообще не следует включать «примечания» в раздел «резюме». ‹примечания› должны быть более уместными. - person Paul Groke; 01.04.2014

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

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

person Emiswelt    schedule 20.07.2011
comment
Спасибо, но наша инфраструктура уже зависит от SC и не может быть так просто изменена. - person Sebastian P.R. Gingter; 20.07.2011