Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do you document your coding standards? [closed]

What have you found to be the best way to publish your coding standards and why?

like image 797
Flory Avatar asked Oct 07 '08 14:10

Flory


2 Answers

We use our code to document the standard. This along side with enforcement from the senior/lead engineers has worked great for us. The reason we don't maintain an actual document is because we've found that nobody reads it and it becomes outdated rather fast.

IMHO all it takes to prove the point is existing code that shows what the style/standard.

Travel light!

like image 56
Scott Saad Avatar answered Nov 18 '22 08:11

Scott Saad


If you are developing in .NET. I would recommend using StyleCop to check your builds. I would also recommend using ReSharper and the StyleCop plugin.

With ReSharper and the StyleCop plugin you get red "squiggly" lines under code that is against the standard and a simple mouse over will explain why. No code reviews, no docs to maintian.

Using StyleCop in your build process will ensure that all code checked-in conforms to the standards.

like image 41
Peter Avatar answered Nov 18 '22 07:11

Peter