XML Documentation Comments

In new development I've selected to use .NET 2005 and of its features the one leveraged most in moving old code is the XML Commenting from which I hope to product documentation.

I've found a problem on the C++/CLI side that I hope someone can help with -- whenever I have a method with a parameter such as array<char> ^ the documenting for that method does not display in Object Browser.

As an example of this problem add the following declarations then compile a .NET Class Library -- add the Class Library as a reference in a C# project and browse in Object Browser. The top method will display correctly while the bottom will not display at all.

///<summary>
///<para>Test Demonstrating XML Documentation Bug.</para>
///<para>This method will document properly and display accordingly from Object Browser.</para>
///</summary>
///<remarks>
///<para>Testing parameters System::String ^strVal vs. array&lt;char&gt; ^strVal</para>
///</remarks>
System::Void Test(System::String ^strVal) {};

///<summary>
///<para>Test Demonstrating XML Documentation Bug.</para>
///<para>This method will document properly and display accordingly from Object Browser.</para>
///</summary>
///<remarks>
///<para>Testing parameters System::String ^strVal vs. array&lt;char&gt; ^strVal</para>
///</remarks>
System::Void Test(array<char> ^strVal) {};



Answer this question

XML Documentation Comments