Question

我知道remarks标签用于提供有关该类的其他信息，但在悬停/调用该类时它不会显示在intellisense中。我想知道它到底有用吗？

Answer 1

备注用于构建文档文件。它们用于更详细的评论，在＆＃34;摘要＆＃34;中添加补充信息。标签（＆＃34;摘要＆＃34;标签确实显示在intellisense中）。

生成的文档文件将采用XML格式。

要生成文档文件，您需要添加＆＃34; / doc＆＃34;编译选项。在visual studio中，您可以通过以下方式启用XML文档文件的生成：

右键单击项目名称 - ＆gt;特性
转到“构建”标签
启用（检查）XML文档文件选项

Answer 2

生成文档时，.NET中的许多标记都得到了充分利用。也许，最受欢迎的，我使用的是Sandcastle。

这是一篇讨论该主题的相当古老的博客文章，但你会明白这一点：

“我认为大多数开发人员都知道使用XML代码注释来装饰.NET对象的概念。实际上有两个好处：1）当你消费对象时它会在intellisense中显示这些信息，2）你可以生成组件文档，如MSDN。“

来源：XML Code Comments and Sandcastle, demystified!

Answer 3

Visual Studio的 IntelliSense 使用这些标记来提供有关您创建的类，函数和属性的提示，如果它们按如下方式正确创建：

在 C＃（以及使用Visual Studio的代码编辑器）中，可以通过键入///（三个正斜杠而不是两个）并按Return键轻松完成。

这将创建＆＃34; XML评论＆＃34;并为您添加最常用的标记（例如，方法的每个参数的参数标记）。
如果光标在类的上方，它将创建一个<summary>标记，如果它位于方法之上，它将为每个参数创建额外的<param>标记，并且{{1} }标记返回值。

然后，当光标在<returns>注释内时（见下面的示例），IntelliSense会建议其他人，例如<remarks>。据我所知，IntelliSense仅使用///和<summary>标记。如果这些标记中的任何一个包含<param>属性，则可以引用其他项（如示例中所示）。

此外，正如其他答案所解释的那样，您可以创建 XML文档，可以使用第三方工具（例如Sandcastle Help file builder）将其转换为超链接文档或静态html文件）。

示例：

cref

Answer 4

可以在C# Guide中读取：

该标记用于添加有关类型的信息，以补充<summary>指定的信息。此信息显示在“对象浏览器”窗口中。

因此<summary>用于元素的简洁描述，<remarks>用于元素的完整描述。编写代码时，智能感知将显示摘要，但在文档或更详细的视图中，将显示注释内容。使用intellisense展示完整的描述会占用很多空间，并且花了很多时间阅读。

Answer 5

就像@Dodger写道。为了给您视觉印象，这里有一个示例

代码：

/// <summary>A <see cref="MonitorGroup"/> device.</summary>
/// <remarks>If not created with belonging new <see cref="Decoder"/> the properties for <see cref="MonitorGroup.Decoder"/>
/// and <see cref="MonitorGroup.MonitorNumber"/> are <c>null</c>.
/// <para>Refactoring necessary 
/// <list type="bullet">
/// <item><description>a MonitorGroup can connect to several decoders</description></item>
/// <item><description>a MonitorGroup can be connected to several monitors.</description></item>
/// </list>
/// a MonitorGroup can connect to several decoders.</para>
/// </remarks>
/// <seealso cref="MonitorGroup" />
public class MonitorGroup : Device<MonitorGroup>

现在在 Visual Studio 中，它显示为

和 DocFX 创建该文件

c＃中备注标记的用途是什么

5 个答案: