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

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

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

11
c# tags xml-documentation

2 ответов

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

посмотрите на файл "C:\Program файлы\Sandcastle\примеры\Sandcastle\тест.cs"

тип может быть одним из следующих:

  • Примечание
  • совет
  • осторожностью
  • безопасность
  • важно
  • VB/VB/VisualBasic / visual basic Примечание
  • cs/CSharp/c#/C# / visual C# Примечание
  • cpp/c++/C++/CPP / visual C++ Примечание
  • JSharp/j#/J# / visual j# Примечание
  • реализовать
  • абонента
  • наследование
14

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

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

0