Geeks With Blogs

News FAQ on the correct forum to post at: http://forums.asp.net/p/1337412/2699239.aspx#2699239
Tatworth

The number of Style Cop issues in the C5 Collections solution as of C5Collection.1E (available at https://c5stylecopped.codeplex.com/releases/view/123627) is a grand total of 19! (The original total was over 40,000!)

In retrospect, I should have started with the core C5 project (reminder – always start with the lowest level of project). The reason for this is that as argument names are made more meaning by example renaming rnode to rightNode, intellisence will pick it up in consuming layers.

Owning to the vast amount of renaming required for proper readability, it would have been better to rename arguments (and occasionally methods) before running GhostDoc Pro. In this case of the C5 Collections solution, it would have been better to run GhostDoc over visible sections of code rather than than the whole file at once. I found GhostDoc Pro’s spell check function very helpful in fixing the various spelling errors in the code.

I found one issue with ReSharper which is documented at http://resharper-support.jetbrains.com/requests/9551. I also found an issue with Style Cop and this is documented at https://stylecop.codeplex.com/workitem/7651. I do regret fixing manually one issue instead of documenting the issue for the benefit of the supplier.

The most time consuming part of style-copping the C5 collections was correcting the exposure of member variables as internal or public, by replacing access with an appropriate property. Also of great use was git as several times, I found it necessary to roll back some changes.

My conclusion is that there is no excuse for not style-copping any C# project. It does help if you have:

  • A 64-bit PC running a 64-bit Windows OS and at least 8Gb of RAM, but I strongly suspect that 16 Gb of RAM would be far better.
  • Visual Studio 2013 Pro by preferably Visual Studio 2013 Universal.
  • ReSharper
  • GhostDoc Pro
  • StyleCop
Posted on Wednesday, June 18, 2014 8:28 PM VS2013 , ReSharper | Back to top


Comments on this post: Style-copping the C5 Collections project

No comments posted yet.
Your comment:
 (will show your gravatar)


Copyright © TATWORTH | Powered by: GeeksWithBlogs.net