Namespace-Level XML comments

How can I add an XML comment to a namespace When I type the usual ''' nothing happens.


Answer this question

Namespace-Level XML comments

  • sebahattingokce

    Are you sure you can't add comments

    Type System.Drawing in your project and note the description that pops up in intellisense.



  • nbozic

    *stumped*

    Ah! hang on. C# doesnt have this but VB.NET does - its one of those C# vs VB.NET things.

    lets see what we can find...



  • stephanielauym

    I think you are referring to the class constructor you can add xml comments on the class constructors, properties, methods/functions

    from what I can see, when I enter System.Drawing, all I get in the tooltip is "namespace System.Drawing"

    That is there by default for any namespace.



  • Steve Severance

    all I get in the tooltip is "namespace System.Drawing"

    Really I get this:

    Namespace Drawing

    The System.Drawing namespace provides access to GDI+ basic graphics functionality. More advanced functionality is provided in the System.Drawing.Drawing2D, System.Drawing.Imaging, and System.Drawing.Text namespaces.

    It doesn't really matter though, I'll just provide the end user with an instruction manual.



  • ShashankG

    You got any ideas

  • Christian Sciberras

    you cant add an xml comment to a namespace but to a class you can.

  • Namespace-Level XML comments