【问题标题】:XML Auto Commenting C# in Visual Studio CodeVisual Studio Code 中的 XML 自动注释 C#
【发布时间】:2015-12-14 19:38:21
【问题描述】:

在 MonoDevelop 中,当我输入“///”时,它会自动生成一个 xml 样式的注释,如下所示:

/// <summary>
/// Describes the variable x
/// </summary>
int x = 0;

有没有办法在 Visual Studio Code 中获得这种行为?

【问题讨论】:

  • 默认情况下,看起来这不适用于局部变量。 /// 虽然适用于方法签名和类属性。你真的评论局部变量吗?
  • 这个没有实际用途,你可以在 Visual Studio 中使用所有属性和方法来做这个,如果它是一个本地变量,那么只需一个注释 (//) 就足够了
  • 这很奇怪。对我来说,它不适用于方法或属性。是否有我需要更改的设置?
  • 明确一点:我使用的是 Visual Studio Code(code.visualstudio.com),而不是常规的 Visual Studio。

标签: c# xml-comments visual-studio-code


【解决方案1】:

此功能不适用于 VS Code 开箱即用的功能,但与大多数功能一样,可通过第三方扩展获得。截至本答案发布时,这是一个流行的扩展,它为 VS Code 提供了一些 XML cmets 支持:

C# XML Documentation Comments Support for Visual Studio Code

如果该扩展程序不适合您,您可以通过搜索 VS Code Marketplace 找到替代方案

【讨论】:

    【解决方案2】:

    C# for Visual Studio Code Extension 1.23.8 开头,当启用Editor: Format On Type. 设置时支持此设置。

    这可以在File/Preferences/Settings/Text Editor/Formatting下的菜单中找到。

    【讨论】:

    • 感谢更新 - 这为我节省了一些时间。
    • 我在 C# 下寻找这个设置。谢谢。
    • 在 Mac 中它位于 Code/Preferences/Settings/Text Editor/Formatting 下
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-01-13
    • 1970-01-01
    • 2016-03-22
    • 1970-01-01
    • 2019-05-14
    • 2020-08-26
    相关资源
    最近更新 更多