xmldoc element layout

Jun 7, 2012 at 6:01 PM

I'm using the R# code cleanup (stylecop, R# 6.1.1000.82), and it keeps wanting to convert this

        /// <param name="str">A string</param>


        /// <param name="str">

        /// A string

        /// </param>


Is there a setting to make it leave single line xmldoc elements alone?

Jun 7, 2012 at 6:15 PM


In th Headers section:

Use single line for declaration headers.

Jun 7, 2012 at 7:19 PM

Thanks! I went through all the StyleCop settings in the Code Cleanup profile and didn't think to look there.

It would be nice to have a 'leave as is' setting though. If the document element has multiple lines of text I prefer starting the content on a new line. If the document element text is short, I prefer the one-liner.

Jun 7, 2012 at 7:29 PM

Theres a work item coming in vNext that standardises all the layout of xmldocs.

Jun 7, 2012 at 7:30 PM

Fantastic. My expectations are exceeded again. :)

Jun 7, 2012 at 11:52 PM

Saw this too but was too lazy to look up the fix... just happened upon this post!  Thanks!