XML comment tag: how to see it?

前端 未结 1 1977
野的像风
野的像风 2021-02-19 01:02

I use Microsoft Visual Studio 2012. When I put code examples into XML comments of C# classes/methods, I wonder: how will user that references my assemblies see that code example

相关标签:
1条回答
  • 2021-02-19 01:27

    A number of XML comment tags appear in IntelliSense only as child elements of other tags. These tags, known as ChildCompletionList tags, are: c, code, example, list, listheader, para, paramref, see and see also.

    /// <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>
    
    0 讨论(0)
提交回复
热议问题