在Visual Studio Code中使用C#自动注释XML

Question

86

在MonoDevelop中，当我打出"///"时，它会自动生成一个类似于以下的XML风格的注释：

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

有没有办法在Visual Studio Code中实现这种行为？

- s2Jakob

3

默认情况下，似乎这对局部变量不起作用。/// 尽管对于方法签名和类属性有效。你真的会注释局部变量吗？ - Andy Wiesendanger

这没有实际用途，你可以在Visual Studio中使用所有属性和方法来完成，如果它是一个本地变量，那么只需要一个注释(//)就足够了。 - bto.rdz

很奇怪，对我来说，它不适用于方法或属性。也许有些设置需要更改吗？ - s2Jakob

https://dev59.com/Qmkx5IYBdhLWcg3wCP-Y - Andy Wiesendanger

3

明确一下：我正在使用 Visual Studio Code（https://code.visualstudio.com/），而不是普通的 Visual Studio。 - s2Jakob

3个回答

54

这个功能在VS Code中并不是默认提供的，但像大多数功能一样，可通过第三方扩展获得。在本回答撰写时，这里有一个受欢迎的扩展程序，向VS Code提供了一些XML注释支持：

如果该扩展不适用于您，您可以通过搜索VS Code Marketplace来找到替代品。

- Keisuke KATO

该扩展已被弃用，因为它已经内置在C# for Visual Studio Code扩展中（请参考Pascal的答案）。 - Elijah Mock

3

如果您同时使用Visual Studio Code处理其他语言，可以仅为C#设置此项：

- JayChase

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Pascal Berger · Accepted Answer

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

可以在菜单中找到设置选项，路径为：文件/首选项/设置（Windows/Linux）或 代码/首选项/设置（macOS）。

所需设置位于文本编辑器/格式化下。

{
    "editor.formatOnType": true,
}