XML Comments, what's going on ? what it takes for you to fix it ???
Hello,
Here is what I got with R#6.1 IT IS malformed!
namespace Application.Data
{
using System.Diagnostics.Contracts;
using Application.Data.Entities;
/// <summary>
/// Represents set of CRUD operations to manage the user data.
/// </summary>
/// <remarks>
/// Eyal Shilony, 22/12/2011.
/// </remarks>
[ContractClass(typeof(IUserRepositoryContract))]
public interface IUserRepository
{
///<summary>
/// Creates a new user.
///</summary>
///<param name="user"> The user to create. </param>
void CreateUser(User user);
///<summary>
/// Gets the user from the data store; returns null if it doesn't exist.
///</summary>
///<param name="username"> The username to look for in the data store. </param>
User GetUser(string username);
///<summary>
/// Updates the user.
///</summary>
///<param name="user"> The user to update. </param>
void UpdateUser(User user);
}
}
It should be.
namespace Application.Data
{
using System.Diagnostics.Contracts;
using Application.Data.Entities;
/// <summary>
/// Represents set of CRUD operations to manage the user data.
/// </summary>
/// <remarks>
/// Eyal Shilony, 22/12/2011.
/// </remarks>
[ContractClass(typeof(IUserRepositoryContract))]
public interface IUserRepository
{
/// <summary>
/// Creates a new user.
/// </summary>
/// <param name="user"> The user to create. </param>
void CreateUser(User user);
/// <summary>
/// Gets the user from the data store; returns null if it doesn't exist.
/// </summary>
/// <param name="username"> The username to look for in the data store. </param>
User GetUser(string username);
/// <summary>
/// Updates the user.
/// </summary>
/// <param name="user"> The user to update. </param>
void UpdateUser(User user);
}
}
I already pointed this in the past, why the heck it isn't fixed ?? hopefully you won't tell me that this is by design and you don't plan to change it because StyleCop doesn't like this very much and I have no plans to change it to this kind of format for all my projects now!
Do something about it...
Please sign in to leave a comment.
Hello Eyal
Do I understand correctly that the problem is that ReSharper doesn't add spaces between /// and xml doc tags during code cleanup? Such functionality has not been added yet and you're welcome to vote for the following request: http://youtrack.jetbrains.net/issue/RSRP-44782, so that it gathers more attention. Please note that if you add those spaces manually, ReSharper should not remove them when you run code cleanup. Thank you!
Andrey Serebryansky
Senior Support Engineer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"
This is extremely important to me, because each time I use the Cleanup Code functionality I need to fix it manually.
Sorry but in my opinion it's wrong, you should at least add that space and make it the default.
Four years have passed since the issue was noted I doubt that you will implement it during the next four years, please do something about it.
I guess it's a time for a plugin.