How to customize code clean up to change the documentation header rules

Hello,

I would like to use code clean up to automatically create the documentation headers in the following way:

/// <summary>
/// Some summary.
/// </summary>
/// <param name="myParam">The param.</param>
/// <typeparam name="TService">The type.</typeparam>
/// <returns>The instance of <typeparamref name="TService"/> or null if the service could not be resolved.</returns>
TService Do<TService>()


This is summary has multiple lines but the rest of fields use a single line. Currently my default settings always use multiple lines.

What is the set of rules that control this behavior? Is it possible?

Thanks.

2 comments

Hello Antonio,

At the moment there's no built-in functionality to automatically add xml
documentation comments. You're welcome to add a feature request at http://youtrack.jetbrains.net/issues/RSRP
or create a custom plug-in for ReSharper that would do this. Thank you!

Andrey Serebryansky
Senior Support Engineer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"

Hello,

I would like to use code clean up to automatically create the
documentation headers in the following way:

/// <summary>

/// Some summary.

/// </summary>

/// <param name="myParam">The param.</param>

/// <typeparam name="TService">The type.</typeparam>

/// <returns>The instance of <typeparamref name="TService"/> or null
if the service could not be resolved.</returns>

TService Do<TService>()

This is summary has multiple lines but the rest of fields use a single
line. Currently my default settings always use multiple lines.

What is the set of rules that control this behavior? Is it possible?

Thanks.

---
Original message URL:
http://devnet.jetbrains.net/message/5302263#5302263



0

Hi Andrey,

thanks for the fast response. I opened the request but I am interested on pursuing the custom plug-in route in parallel, can you provide me any pointers to some code examples on how to do this type of plugin customization?

Thanks!

Antonio

0

Please sign in to leave a comment.