ReSharper 2024.1 Help

Code inspection: Invalid XML documentation comment

In contrast to regular comments, XML documentation comments that begin with triple slashes /// must have a specific structure and use supported XML tags.

When XML documentation is written correctly, you can use tools to automatically generate documentation for your codebase and view symbol documentation in IDEs in a comprehensive way.

This inspection helps identify a number of problems in XML documentation comments, including:

  • Non-closed tags.

  • Unknown or ambiguous references in the <see cref=""/> tag.

  • Double slashes instead of triple slashes on some lines

Although all these issues will not affect the functionality of your code, they are still worth addressing to improve the maintainability of your code and usability of your APIs.

Last modified: 27 May 2024