xmldoc element layout

Jun 7, 2012 at 7:01 PM

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

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

into 

        /// <param name="str">

        /// A string

        /// </param>

 

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

Coordinator
Jun 7, 2012 at 7:15 PM

ReSharper->Options->Tools->StyleCop

In th Headers section:

Use single line for declaration headers.

Jun 7, 2012 at 8: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.

Coordinator
Jun 7, 2012 at 8:29 PM

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

Jun 7, 2012 at 8:30 PM

Fantastic. My expectations are exceeded again. :)

Jun 8, 2012 at 12:52 AM

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