More extensive coding standard
Status: Alpha
Brought to you by:
dan_vale
Menu
▾
▴
Refer to the "Coding Standard" thread:
http://sourceforge.net/projects/stars-nova/forums/forum/662538/topic/3657750
Refer to the "What should be in version 0.5?" thread that introduced the idea of using StyleCop:
http://sourceforge.net/projects/stars-nova/forums/forum/662538/topic/3725865
I have a bit of experience from another project using StyleCop to enforce a coding standard so this task suits me well.
Will try to trim down the number of exclusions in Settings.StyleCop to the bare minimum by making the code conform to the StyleCop rules.
Current StyleCop rule progress:
- Documentation rules just started.
- Layout rules just started.
- Maintainability rules almost complete. Only missing the private field rule (SA1401).
- Naming rules almost complete. Only missing the lower case field name rule (SA1306).
- Ordering rules in progress. Most of the element ordering rules remains.
- Readability rules completed.
- Spacing rules completed.
Naming rules complete.
Confirmed: Style Cop errors need to be fixed for 0.5
I have turned off spacing rules 1003 and 1008 as they force there to be no spacing around the logical negation symbol, which hides it and makes the logic harder to decipher.
ie StyleCop wants:
if (!LogicToBeNegated) NoViolation();
I preffer:
if ( ! LogicToBeNegated) NoViolation();
Unfortunately this will not enforce the preferred layout, just allow it.