1
XML Doc Comment is reformatted from original XML Doc Comment format
Problem reported by Danny McNaught - 8/16/2017 at 9:40 AM
Submitted
I know it saves lines in Visual Studio but I Collapse Doc comments any way.  The updated format is hard to read when Doc comment is Expanded.
 
Started with this:
    /// <summary>
    ///    Class MainWindow
    /// </summary>
    /// <autogeneratedoc />
    /// <remarks>
    ///   <para><b>History:</b></para>
    ///   <list type="table">
    ///    <listheader>
    ///     <devName>Developer\Date\Time</devName>
    ///     <devCompany>Developer Company</devCompany>
    ///     <devPhone>Developer Phone</devPhone>
    ///     <devEmail>Developer Email</devEmail>
    ///     <devMachine>Developer On</devMachine>
    ///     <description>Description</description>
    ///    </listheader>
    ///    <item>
    ///      <devName>
    ///   Developer: Danny C. McNaught
    ///   <para>Date: Wednesday, August 16, 2017</para>
    ///   <para>Time: 12:36 PM</para>
    ///  </devName>
    ///     <devCompany>United States Postal Service</devCompany>
    ///     <devPhone>(919) 424-9259</devPhone>
    ///      <devEmail>
    ///   <a href="mailto:danny.mcnaught@dxc.com">mailto:danny.mcnaught@dxc.com</a>
    ///   <para><a href="mailto:danny.c.mcnaught@usps.gov">mailto:danny.c.mcnaught@usps.gov</a></para>
    ///   <para><a href="mailto:sfcsarge@outlook.com">mailto:sfcsarge@outlook.com</a></para>
    ///  </devEmail>
    ///     <devMachine>SURFACEPRO3VM</devMachine>
    ///     <description>Created XML Comment</description>
    ///    </item>
    ///   </list>
    /// </remarks>
 
After Editor save: I get this.
    /// <summary>Class MainWindow</summary>
    /// <remarks>
    /// <para><b>History:</b></para><div class="tableSection"><table width="100%" frame="lhs" cellSpacing="2" cellPadding="5"><tbody><tr><th>Developer\Date\Time</th><th>Developer Company</th><th>Developer Phone</th><th>Developer Email</th><th>Developer On</th><th>Description</th></tr><tr><td>
    ///   Developer: Danny C. McNaught
    ///   <para>Date: Wednesday, August 16, 2017</para><para>Time: 12:36 PM</para></td><td>United States Postal Service</td><td>(919) 424-9259</td><td><a href="mailto:danny.mcnaught@dxc.com">mailto:danny.mcnaught@dxc.com</a><para><a href="mailto:danny.c.mcnaught@usps.gov">mailto:danny.c.mcnaught@usps.gov</a></para><para><a href="mailto:sfcsarge@outlook.com">mailto:sfcsarge@outlook.com</a></para></td><td>SURFACEPRO3VM</td><td>Created XML Comment</td></tr></tbody></table></div>
    /// </remarks>
 

2 Replies

Reply to Thread
0
Danny McNaught Replied
Great Product Serge Keep up the great work. Thanks.
0
Paulo Morgado Replied
+1. The editor should never convert the documentation tags to HTML.
Paulo Morgado

Reply to Thread