Home/ Questions/Q 8836751
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-14T09:33:59+00:00

Lately I started using /// to comment my C# code rather than // or

  • 0

Lately I started using /// to comment my C# code rather than // or /* because it is just much simpler to use. Today I started wondering why there were different types and came across this SO question which states that /// comments are for generating the xml documentation.

I can’t find any advice with regards to on type of comments vs another on Google and I take that to mean that it doesn’t matter either way. I’m not getting any ill effects so far from using /// to comment, but I’d hate to get into a habit now just to unlearn it later. As far as I can tell, if there are no metatags in the comments it does not get recognised as being documentation (or am I completely wrong on that?)

Before I riddle my code with /// comments, is this type of commenting a big no-no? Could there be potential problems from commenting this way?

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    Could there be potential problems from commenting this way?

    Yes. When you decide to generate your project documentation, then it will have all those commented lines as part of your XML documentation. When you compile the code using /Doc extension then it generates a document using your XML comments (///). If you have used that to comment out your code, then the document generate will consider the commented out code for your documentation.

    Please see:

    XML Documentation Comments (C# Programming Guide)

    How to: Generate XML Documentation for a Project

    • 0