微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

c# – XML注释标签:怎么看?

我使用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>

原文地址:https://www.jb51.cc/csharp/99852.html

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐