Recently, I have compiled C # coding standards for my company. I haven't studied much about this in the past. I just thought that the code can make my own sense.
I have referred to the following materials
- C # coding conventions
- . Net Design Specification Convention usage and mode (version 2nd)
- The art of writing readable code
- Refactoring-improving the design of existing code
- 45 habits of efficient programmers
- Clean code
It is very difficult to write a code specification. It depends on the experience of the coders, the level of team members, the specific business needs, and the complexity of the project, project Progress, corporate culture, and so on.
In addition, there are always a lot of ideas to write when writing a pen, but as a standard, it cannot be too long to be simplified.
This is the chapter to be written.
1. Naming rules
1.1 naming conventions
1.2 naming and selection
1.3 Best naming practices in specific scenarios
2. Notes
2.1 Comments and conventions
2.2 unnecessary comments
2.3 required comments
3. Format
4. Exception Handling
5. coding Best Practices
In the next few days, I will write the subsequent chapters one after another. I also hope that you can help me think about the coding specifications that need to be covered.
After writing the entire code specification, I will provide you with a complete Word document.
Now, I want you to discuss whether there are unreasonable content in the document and what else needs to be covered.