none
Multiple summary elements in XML documentation

    Question

  • I am using Visual Studio 2010 SP1. I would like to use XML Documentation for my user controls to see them in Intellisense.

    If I add a WPF User Control "MyUserControl" to my WPF project and add a <summary> element like so:

    /// <summary>
    /// User Control to visualize domain data XY...
    /// </summary>
    public partial class MyUserControl : UserControl
    {

    Then Intellisense shows only the summary "MyUserControl".

    In the MyUserControl.g.cs file I can see that the class has XML documentation as well:

    /// <summary>
    /// MyUserControl 
    /// </summary>
    [System.CodeDom.Compiler.GeneratedCodeAttribute("PresentationBuildTasks", "4.0.0.0")]
    public partial class MyUserControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector {
    

    In the generated XML documentation file I see both <summary> elements present.

    How can I suppress the automatically generated <summary>?

    • Moved by Kristin Xie Tuesday, January 12, 2016 3:04 AM
    Friday, January 08, 2016 9:03 AM

Answers

All replies

  • https://tiesontrowbridge.com/tutorial/c-xml-and-linq-deleting-an-xml-node
    Friday, January 08, 2016 2:50 PM
  • https://tiesontrowbridge.com/tutorial/c-xml-and-linq-deleting-an-xml-node

    I am not asking how to remove an XML element from an XML document... this answer is not helpful.
    Friday, January 08, 2016 3:37 PM
  • https://tiesontrowbridge.com/tutorial/c-xml-and-linq-deleting-an-xml-node


    I am not asking how to remove an XML element from an XML document... this answer is not helpful.

    What? You can't suppress the auto generation of anything. All you can do is remove it after the generation.
    Friday, January 08, 2016 4:02 PM
  • All you can do is remove it after the generation.
    Of course, but I would have to remove it from a .cs file, not an XML document. The provided link does not help either.
    Friday, January 08, 2016 4:37 PM
  • All you can do is remove it after the generation.

    Of course, but I would have to remove it from a .cs file, not an XML document. The provided link does not help either.

    Then you are stuck then, and you can't squeeze blood out of a turnip.
    Friday, January 08, 2016 4:47 PM
  • Hi Andreas Helbling

    This forum is about the C# programming language, IDE, libraries, samples, and tools, as your issue is more related to the Visual Studio itself, we help you move it to the Visual Studio General Questions forum for better support.

    Thank you for your understanding.

    Best Regards,

    Albert Zhang

    Tuesday, January 12, 2016 3:01 AM
  • Hi Andreas Helbling,

    According to the MSDN article, we need to add the comments with /// and then generate a XML document. And "The <summary> tag is used by IntelliSense inside Visual Studio to display additional information about a type or member."

    https://msdn.microsoft.com/en-us/library/z04awywx%28v=vs.100%29.aspx?f=255&MSPPError=-2147217396

    And following article introduce how to Supplying XML Code Comments, hope that can help you.

    https://msdn.microsoft.com/library/s0we08bk(v=vs.100).aspx

    https://msdn.microsoft.com/en-us/library/z04awywx(v=vs.100).aspx

    In addition, please check the XML document path, whether it is listed in the project path which in the same path with your UserControl.

    Best Regards,
    Weiwei

    Thursday, January 14, 2016 7:46 AM
    Moderator
  • Hello Weiwei

    My problem is that IntelliSense only shows the auto-generated <summary> and not the <summary> that I wrote in the code-behind file to document my user control. So I can't see MY <summary> with Intellisense. Please advise: Is it a bug? Is there a workaround?


    Thursday, January 14, 2016 10:22 AM
  • Hi Andreas Helbling,

    According to the MSDN articles and I create a custom UserControl in my side with Visual Studio 2010 sp1, even I have generated the XML document and include it in the path of my UserControl, I also don't get the custom <summary> with Intelligence too.

    So I suggest you post this problem to Visual Studio Connect with the detailed steps you do, and share the link here, which can let other communities who has the same problem vote and add comments for this feedback. I think the report team experts will evaluate this problem seriously.

    https://connect.microsoft.com/visualstudio

    Thanks for your feedback for the VS products.

    Best Regards,
    Weiwei



    Friday, January 15, 2016 1:21 AM
    Moderator
  • Hello Weiwei

    Bug reporting for VS 2010 is not/no longer available in Connect.

    Friday, January 15, 2016 8:18 AM
  • Hi Andreas Helbling,

    Please select the last option in Report a Bug -> Visual Studio Feedback Center -> Visual Studio, .NET Framework, and Silverlight Bug Form, which is the new bug submission form for VS.

    After submitting, please share the link here, I will vote this feedback. Thanks for your feedback again.

    Best Regards,
    Weiwei


    Monday, January 18, 2016 1:15 AM
    Moderator
  • Hello Weiwei

    Sorry, but this option is not available for me (connecting from Switzerland)

    Wednesday, January 20, 2016 1:24 PM
  • Hi Andreas Helbling,

    As far as I know the Visual Studio 2010 won't update. So even we submit this bug, I'm afraid it won't be fixed.

    And I try the XML Document in Visual Studio 2013, it works fine. So I recommend you using Visual Studio 2013. The Community version free, please download from below link.

    https://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx

    Best Regards,
    Weiwei


    Thursday, January 21, 2016 1:24 AM
    Moderator