Можно ли сгруппировать XML документацию из списка тегов в C # - PullRequest
Новая
       48

Можно ли сгруппировать XML документацию из списка тегов в C #

0 голосов
/ 25 февраля 2019

Я использую Doxygen для моей проектной документации C #.И теперь мне нужно сделать документацию для одного метода с таблицей.Документация MSDN об этом теге очень плохая: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/list

Если я использую тег xml <list type="table">, Doxygen предоставит мне красивую таблицу.Но я хочу создать таблицу с документацией, полученной из более чем одного метода.

Например, если я предоставлю методы MethodA и MethodB с тегами <list type="table"> в документации XML, Doxygen сгенерирует две таблицы,Поэтому вопрос в том, можно ли заставить его сгруппировать их по какому-либо свойству (я пытался добавить name="my_table" and id="my_table", но это, конечно, не сработало). 

/// <summary>
/// AAA
/// </summary>
/// <list type="table" name="my_table" id="my_table">
///     <item>
///         <term> item AAA term </term>
///         <description> item AAA description </description>
///     </item>
/// </list>
public void MethodA()
{ // Some code here... }

/// <summary>
/// BBB
/// </summary>
/// <list type="table" name="my_table" id="my_table">
///     <item>
///         <term> item BBB term </term>
///         <description> item BBB description </description>
///     </item>
/// </list>
public void MethodB() 
{ // Some code here... }

И вот пример того, как этозаботится о генерации документацииenter image description here

Обновление: В настоящее время Doxygen не может использовать теги.http://www.doxygen.nl/manual/xmlcmds.html

...