Oh StyleCop, how I loath thee…
StyleCop is generally ok except when it isn't.
My BIGGEST pet peeve with StyleCop is it’s stupid requirements for Property documentation. If it’s a read only property it HAS to start with “Gets “ and if it’s not readonly it HAS to start with “Gets or sets “. How irritating. Most of the time, my properties are well named (should be?) and aren’t used for anything complex. As soon as a property starts bloating up with logic I begin to think perhaps that should be a method.
Enter: GhostDoc
I was introduced to GhostDoc by Rob MacLean and Rudi Grobler who overheard me moaning about StyleCops annoying requirements. What an amazing tool, this definitely does into the list of Must-Haves in my dev environment!
With a simple Ctrl + Shift + D, GhostDoc automagically spits out the proper comments required for StyleCop and best of all, the comments make sense! I’m in love!
All this documentation was generated by GhostDoc, not a word typed by me.
No comments have been posted yet