Вывод XML-комментариев веб-сайта ASP.NET

Question

Я хотел бы документировать исходный код моего веб-сайта VB.NET.

Как преобразовать комментарии XML на веб-сайте VB.NET ASP.NET в файл документации XML?

Я не вижу возможности для создания файла документации XML на страницах свойств веб-сайта VS.

Answer 1

Уточнив, что этот вопрос относится к веб-сайту VB.NET ASP.NET, рассмотрим следующее на основе соответствующей дискуссии на форумах MSDN:

1. Я подтвердил, что GhostDoc Pro может, по крайней мере, создать файл справки для веб-сайта VS VB.NET на основе его комментариев XML. К сожалению, бесплатная версия GhostDoc не может создать файл справки; но личная лицензия на GhostDoc Pro довольно недорогая; и я нашел GhostDoc Pro достаточно полезным в целом, чтобы стоить покупать.
2. Кроме того, Sandcastle Help File Builder (SHFB) - который бесплатно и я также использую и люблю - якобы может облегчить вывод файла документации XML и создать файл справки для веб-сайта VS VB.NET. Как и с большинством вещей S(HFB), я ожидаю, что это правда... но также потребуется обязательство перейти в конечную зону.

См. Раздел "Документирование проектов веб-сайтов и веб-сервисов" в разделе " Документирование веб-проектов" документации SHFB для получения дополнительной информации о параметре SHFB.

Я подтвердил, что по сообщениям требуется EWSoftware.CodeDom.dll включен в дополнения SHFB (под Sandcastle\Extras с установкой по умолчанию) - вместе с соответствующим файлом справки.

Кроме того, в вышеупомянутой документации SHFB объясняется, что вам нужно будет добавить раздел, подобный следующему, на ваш веб-сайт VB.NET. Web.config для того, чтобы использовать EWSoftware.CodeDom.dll:

<configuration>
  <system.codedom>
    <compilers>
      <compiler language="vb;vbs;visualbasic;vbscript" extension=".vb"
        compilerOptions="/docpath:C:\Publish\Docs"
        type="EWSoftware.CodeDom.VBCodeProviderWithDocs,
              EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral,
              PublicKeyToken=d633d7d5b41cbb65">
        <!-- NOTE: Change value to "v3.5" for .NET 3.5 projects -->
        <providerOption name="CompilerVersion" value="v2.0"/>
      </compiler>
    </compilers>
  </system.codedom>
</configuration>

Следующий снимок экрана суммирует эти параметры и предоставляет немного больше контекста, чтобы помочь:

Answer 2

Попробуйте скомпилировать с /doc вариант. Насколько я помню, он работает только с XML-комментариями в коде.