Skip to content

Our XML comments are using <code> (block element) instead of <c> (inline element) #3475

Closed
@jnm2

Description

@jnm2

Example:

/// <summary>
/// Verifies that the object that is passed in is not equal to <code>null</code>
/// If the object is <code>null</code> then an <see cref="AssertionException"/>
/// is thrown.
/// </summary>

Visual Studio has recently begun taking the XML comment formatting tags seriously, so it may make a difference.

I would recommend that we add the design-time tool https://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers to our Directory.Build.props and follow all its prompts. It's been awesome in every project where I've seen it. I know it catches this particular case.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions