是否可以通过C#

时间:2019-02-25 14:19:19

标签: c# doxygen xml-documentation

我正在将Doxygen用于C#项目文档。 现在,我需要使用表制作一个方法的文档。 MSDN文档对此标签的了解很差:https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/list

如果我使用xml <list type="table">标记,Doxygen将为我提供美观的表。 但是我想用从一种以上方法接收到的文档制作一张桌子。

例如,如果我在xml文档中提供了带有MethodA标签的方法MethodB<list type="table">,则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

0 个答案:

没有答案
相关问题