换行中的对象摘要


97

问候

在设置属性/字段/方法等的摘要时,是否可以在其中添加换行符?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

当我设置它时,它显示为鼠标悬停:

bool TestLine
This is line 1 This is line 2

但我希望它显示为:

bool TestLine
This is line 1 
This is line 2

我试过使用,\n但不起作用。有什么办法可以做到这一点?

Answers:


185

你想用这样的东西

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

1
@YetAnotherUser,空白行呢?
Behzad

1
@Behzad尝试使用<para>&nbsp;</para>
YetAnotherUser 2013年

15
我讨厌那些多余的词:(
JanMacháček16年

10
在Visual Studio 2017 IDE中,上面的``解决方案''实际上在第1行和第2行之间显示一条单独的空白行(即第1行之后的换行符,然后是空行,然后是第2行)-这是不一样的根据操作员的要求换行。这是VS 2017 IDE中的错误吗?还是每个投票赞成的人都没有看到这个答案没有产生OP所期望的输出吗?
Jazimov '18

那是新段落,而不是新行。在我看来,文档语法有些限制。
GrizzlyMcBear,

33

是:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

10

这可能是一个旧线程,但我在使用Visual Studio 2019时正在寻找ananser 。我想要段落和换行符。以下对我来说很有效:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

产生以下内容:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
对于VS2019及更高版本,此答案在技术上比公认的答案更正确。
莱恩·沃尔特斯

您也可以只在VS2019行的结尾处使用<br />。这些解决方案会产生实际的换行符,而不是带有空行的新段落!谢谢
Phillip S

5

您可以用来<para />在摘要中添加新行:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

好像:

Main comment
Line 1
Line 2

最好的祝福!


2

我只是为像我这样使用Xamarin Studio的任何人添加此代码。我发现上述解决方案均不适合我,但此解决方案确实有效:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

这给出以下输出:

Summary  
Main summary line.

Your secondary summary

1

如果您使用的是Swashbuckle(Swagger Web API集成库),<para></para>则应替换为<p></p>并且<br/>也可以使用。

所以下面

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

变成

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

该问题已在此处描述: 如何在Swashbuckle文档中添加换行符?-采用特殊配置,domaindrivendev的评论, https://github.com/domaindrivendev/Swashbuckle/issues/258 -上<br/>使用。


0

您可以合法地添加para标签,但这实际上为每条新行创建了一个新段落,并且行距似乎消失了。
我个人在段落周围添加了1个段落,然后br在要中断的行的末尾添加了标签,以保留适当的行距:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

3
这是行不通的,并且<para>的间距也没有关系。您正在使用哪个版本的VS / .Net?
Dani

2
HTML标记将被忽略summary,即使它们位于para标记内。
Lazaro Fernandes Lima Suleiman

-7

如果您希望摘要中多行而不使其复杂,我建议使用这种格式。如果您在每行之后使用<br />标签,它将起作用(在文本内的任何位置使用它都会在标记所在的位置换行。)

但是,请注意,如果<br />标记后有空格,则在下一行将获得一个额外的空格。因此,您希望每行具有相同的空间,因此每一行都将成一条直线。

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }

3
在寻找解决方案之前我尝试过的第一件事,因为那不起作用!
菲利普

也为我工作。推荐
AlexWei
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.