locked
Does C++ have something like /// <summary> to add object browser comments?

    Question

  • For VS 2012 C++ Metro projects, is there any way to add comments to classes and there members that show up in the object bowser?  (As in c# with <summary>)

    I looked for a setting to enable /doc, but could not find it.


    Jim Tomasko

    Wednesday, June 13, 2012 6:56 AM

Answers

  • Hi Jim,

    unfortunately, the C++ language service does not add the doc comments to the object browser as the C# does.  The object browser calls into the language service's implementation of IVsSimpleObjectList2::FillDescription2 where the language service (vcpkg.dll) adds the text to the richtextbox of the object browser pane. 

    The doc setting for C++ is set in the project properties dialog (right click on the project node in solution explorer), expand the configuration properties | C/C++ node, all options | Generate XML Documentation Files, set to Yes.

    Please submit the feature request via the uservoice link to see if the product group can add this in

    http://visualstudio.uservoice.com/forums/121579-visual-studio

    much appreciated,

    mike

    • Marked as answer by James Tomasko Thursday, June 14, 2012 12:26 AM
    Thursday, June 14, 2012 12:11 AM
    Moderator