Добавьте исходную документацию .NET на уровне пакета / пространства имен для обработки с помощью Doxygen

Question

Я использую комментарии к документации по doxygen и XML для создания внутренней документации API для наших библиотек фреймворков.

Doxygen создает «пакет» для пространства имен.Интересно, возможно ли добавить исходную документацию на уровне пространства имен для отображения в представлении пакета Doxygen?

Answer 1

Это можно сделать с помощью стандартного <summary> стиля комментирования XML.

Несмотря на то, что Visual Studio не распознает тот факт, что пространство имен можно комментировать, добавление сводной документации над любым объявлением пространства имендобавьте это описание в сгенерированную документацию.

Например:

using System;
using System.Web;
using System.Web.Caching;

/// <summary> 
/// Testing namespace package descriptions
/// </summary>
namespace MyProject.Caching
{
   ...

Вам нужно добавить только один экземпляр комментариев XML для каждого пространства имен.Например, если у вас есть два класса и один интерфейс, которые все объявлены в одном и том же пространстве имен, вам нужно только один раз предоставить комментарии, чтобы Doxygen добавил описание для этого пространства имен.Независимо от того, добавляете ли вы эти комментарии к любому из ваших классов или к интерфейсу.

Если добавляются конфликтующие описания пространства имен, Doxygen будет выбирать только первый найденный экземпляр и игнорировать все остальные.