时间戳

首页 > 解决方案 > 如何在 C# 代码文档中保留换行符

c# - 如何在 C# 代码文档中保留换行符

问题描述

多年来，人们可以将元素用于此处<code/>记录的各种固定格式文本。该文档特别提到了“多行代码”，并且示例（如this one）展示了它如何用于多行代码示例。

但是，最新版本的 Visual Studio（2017、2019）开始将内容格式化<code/>为自由流动的文本，忽略任何换行符。（如果元素在类摘要中，则将鼠标悬停在类名上即可看到效果。）

所以，假设我必须将一个 XML 片段放入 codedoc。我需要保留换行符，理想情况下不必用 标记它们<br/>，以便它们可以轻松复制和粘贴进出。

我怎样才能做到这一点？

标签： c#visual-studiocode-documentation

解决方案

尝试将其包装在<example>标签中：

示例标签允许您指定如何使用方法或其他库成员的示例。这通常涉及使用代码标签。

以及来自文档的示例：

    /// <summary>
    /// The GetZero method.
    /// </summary>
    /// <example>
    /// This sample shows how to call the <see cref="GetZero"/> method.
    /// <code>
    /// class TestClass
    /// {
    ///     static int Main()
    ///     {
    ///         return GetZero();
    ///     }
    /// }
    /// </code>
    /// </example>
    public static int GetZero()
    {
        return 0;
    }

推荐阅读