Are there any suggestions for developing a C coding standards best practices document

Question

I'm a recent AI graduate (about 2 years) working for a small company. It has been assigned to me (mainly since I am the department's first 'adopter') to write a rudimentary (read: useful?) C# coding standards manual.

I suppose I should add that I'm probably the least experienced software engineer on the team, but I'm looking forward to this work because I'm hoping to generate something half-useful. I conducted a thorough Internet search and read articles on what should and should not be included in a coding standards document. This appears to be as good a place as any to solicit advice.

I'm well aware that I'm going to open the door to a whole universe of debate about 'the right way to do things.' I understand and respect the undeniable fact that each programmer has a preferred method of solving each individual task; as a result, I'm not looking to write anything so draconianly proscriptive as to suffocate personal flair, but rather to try to establish a general methodology and agreed standards (e.g. naming conventions) to aid in making individual code more readable.

Do you have any suggestions? Ideas?

Answer 1

I would ask you to start out with this guidelines for .NET fundamentals: https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/?redirectedfrom=MSDN

Hope it helps