来自 C# .NET 注释的 Doxygen 注释中的有序列表

本文关键字：注释 列表 Doxygen 来自 NET | 更新日期: 2023-09-27 17:56:14

我有一些C#文档注释，如下所示：

/// <para>
/// Pre-Conditions:
/// </para>
/// <para>
///     1. The sky must be clear.
/// </para>
/// <para>
///     2. It must be night time.
/// </para>
/// <para>
/// Post-Conditions:
/// </para>
/// <para>
///     1. A picture of the sky will be saved.
/// </para>
/// <para>
///     2. Some second thing will be true that I can't think of.
/// </para>
/// <para>
/// Invariants:
/// </para>
/// <para>
///     1. Existing pictures will not be changed.
/// </para>
void TakePictureOfStars();

我将所有内容都设置为自己的段落，以便在Visual Studio中使用鼠标悬停工具提示时正确显示。

我使用Doxygen来生成注释，但我不断得到以下HTML：

<ol type="1">
    <li>The sky must be clear.</li>
</ol>
<ol type="1">
    <li>It must be night time.</li>
</ol>

它看起来像这样：

1. The sky must be clear.
1. It must be night time.

因此，这里有一个问题：如何让每个编号项在 Visual Studio 工具提示中显示在自己的行上，并在代码输出中获取有序列表？

来自 C# .NET 注释的 Doxygen 注释中的有序列表

将

MARKDOWN_SUPPORT设置为NO将避免该 1。2. 3.标记被视为有序列表。

为了保留空间，您可以使用<pre>和</pre>：

/// <para><pre>
/// Pre-Conditions:
/// </pre></para>
/// <para><pre>
///     1. The sky must be clear.
/// </pre></para>
/// <para><pre>
///     2. It must be night time.
///        a. half moon
///        b. full moon
/// </pre></para>
相关文章：