c# – XML注释标签：怎么看？

发布时间：2020-12-15 07:53:43 所属栏目：百科来源：网络整理

导读：我使用Microsoft Visual Studio 2012. 当我将代码示例放入C#classes / methods的 XML注释中时,我想知道：引用我的程序集的用户将如何看到该代码示例？我试图引用我自己的程序集,我找到的唯一方法是：查看assembly.xml文件. 我可以解决Visual Studio或其他任

我使用Microsoft Visual Studio 2012.
当我将代码示例放入C#classes / methods的 XML注释中时,我想知道：引用我的程序集的用户将如何看到该代码示例？

我试图引用我自己的程序集,我找到的唯一方法是：查看assembly.xml文件.
我可以解决Visual Studio或其他任何东西来查看这些代码示例吗？

以下是我发表评论的内容：

/// <summary>
/// This is my method example
/// </summary>
/// <example>
/// <code>
/// // Here is my code example. Call my method like this:
/// const int a = 10;
/// MethodExample(a);
/// </code>
/// </example>
public static void MethodExample(int parameter)
{
}

这是我在intellisense中得到的：

这是我在对象浏览器中得到的：

这是我在assembly.xml文件中得到的：

我想得到的内容：请参阅对象浏览器和智能感知中的代码示例.

解决方法

许多XML注释标记仅作为其他标记的子元素出现在IntelliSense中.这些标记称为ChildCompletionList标记,它们是：c,代码,示例,列表,listheader,para,paramref,另请参见.

/// <summary>
/// MethodExample the function that does it all...
/// <example>
/// <code>
/// <para/>// Here is my code example. Call my method like this:
/// <para/>const int a = 10;
/// <para/>MethodExample(a);
/// </code>
/// </example>
/// </summary>

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!