Skip to content

Full recommended tags support #10

@Jan0660

Description

@Jan0660

From https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags.

  • General Tags used for multiple elements - These tags are the minimum set for any API.
    • <summary>: The value of this element is displayed in IntelliSense in Visual Studio.
    • <remarks>: Tags used for members - These tags are used when documenting methods and properties.
    • <returns>
    • <param>
    • <paramref>
    • <exception>
  • Format documentation output - These tags provide formatting directions for tools that generate documentation.
    • <para>
    • <list>
    • <c>
    • <code>
    • Include examples #7
    • <inheritdoc> (should be handled by docfx itself)
    • <include>
  • Generate links and references - These tags generate links to other documentation.
    • <see>
    • <seealso>
    • cref
    • href - maybe already is?
  • Tags for generic types and methods - These tags are used only on generic types and methods
    • <typeparam>
    • <typeparamref>

the compiler and Visual Studio validate the <b>, <i>, <u>, <br/>, and <a> tags.

  • <b>
  • <i>
  • <u>
  • <br/> (also support <br /> with the space just to be sure)
  • <a>

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions