Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Full recommended tags support #10

Open
9 of 24 tasks
Jan0660 opened this issue May 17, 2023 · 1 comment
Open
9 of 24 tasks

Full recommended tags support #10

Jan0660 opened this issue May 17, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@Jan0660
Copy link
Owner

Jan0660 commented May 17, 2023 •
edited
Loading

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>
@Jan0660 Jan0660 added the enhancement New feature or request label May 17, 2023
@alec1o
Copy link

alec1o commented Sep 6, 2024

Soo big task! Waiting for v1.0 😆

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Jan0660 @alec1o