格式化多行注释是否需要扩展？

Question

在Visual Studio中，为C＃方法提供以下XML文档注释：

/// <summary>
/// First line is very long long long long long long long long,
/// and the second is short.
/// </summary>
void Method()

是否有任何扩展名可以自动格式化以上注释，以免行太长？像这样：

/// <summary>
/// First line is very long long long long long
/// long long long and the second is short.
/// </summary>

Answer 1

一种执行此操作的方法是添加para，该格式实际上会格式化段落中的注释。

/// <summary>
/// First line is very long long long long long
/// <para>long long long and the second is short.</para>
/// </summary>
void Method()

悬停时，在调用此方法时，摘要注释会按多行排列，如下图所示：

---

特定于Visual Studio扩展，可以使用Rewrap和Auto Comment Blocks。

  

重新包装

     

将代码注释和其他文本重新格式化为给定的行长。对于VSCode和Visual Studio。

     

自动注释块

     

为大多数官方支持的语言提供Javadoc样式的多行注释和单行注释块的块注释完成。

您需要的是重新包装。

Answer 2

您也可以使用扩展名VSdocman（免责声明，我是作者）来执行此操作。它可以做很多其他事情，但是它也可以重新包装XML文档注释。只需打开其WYSIWYG comment editor并将其关闭。它将根据您的settings换行。