Home/ Questions/Q 906545
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-15T16:24:19+00:00

I’m finishing up a project I’ve been working on for a while, and am

  • 0

I’m finishing up a project I’ve been working on for a while, and am just putting on the final touches.

One thing I would like to do is add class descriptions at the top of each class file (to help myself and other programmers figure out what’s going on). My thought is to just use a bunch of ‘/”s to rope off a section for me to write some notes, but maybe there is a better way? Is there a built in way to do this in Visual Studio?

/////////////////////////////////////////////////////
//                                                 //
// KillZombies.cs                                  //
//                                                 //
// Description: This class contains blah blah blah //
//                                                 //  
/////////////////////////////////////////////////////
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    Yes, you should use the normal XML documentation:

    /// <summary>
/// Describe your class quickly here.
/// </summary>
/// <remarks>
/// Add more details here.
/// </remarks>

    That way it will show up in Intellisense, and if you build your documentation with Sandcastle/ndoc/Doxygen etc it will appear appropriately.

    If you type “///” in the line above your class, you should see an appropriate template to get started. See the MSDN link above for more information.

    • 0