Wednesday, April 11, 2007
Top 10 Coding Guidelines for C#
Here is a set of coding guidelines that we use to generate code. Using these guidelines we strive to build software that improves the 'able' criteria such as maintainable, readable, reliable, expandable, reusable, etc. The measurement of these criteria is somewhat subjective.
It should be noted that the biggest factors that impact the 'able' criteria are made by selecting C#, .net and Visual Studio development environment. The guidelines merely refine the results.
Here is out top 10 .net C# coding guidelines.
It should be noted that the biggest factors that impact the 'able' criteria are made by selecting C#, .net and Visual Studio development environment. The guidelines merely refine the results.
Here is out top 10 .net C# coding guidelines.
- Use Object Oriented (00) principles.
- Use unit tests.
- Avoid global (or static) properties or variables.
- Make extensive use of core .net classes such as Collection and Regular Expressions
- Use strong typing and avoid the use of the "object" type.
- Use Auto-Generated Code
- Use a naming convention.
- Use Static Methods and Constants
- Use the "this" keyword.
- Use Regions to place code in Chapters and Sections.
Labels: C Sharp, CodingGuideline C#
Tuesday, April 10, 2007
Make Use of #regions When Developing C# .net Code - Coding Guidlines Series
The is part of a .net Coding Guidelines series of blog postings.
Making code readable is an important consideration when developing and maintaining code. The single best way to make code more organized, thus more readable, is to use "region" compiler directive. Regions effectively group your code into sections and chapters.
This is a simple example of code without the region directive. The code is all there but even with just a few lines it can be difficult to read because nothing stands out. This only gets worse when the class is hundreds or thousands lines long.
Here is the same code with regions. It just looks a lot cleaner.
Now when you have found the selection that you want it is simply a matter of double clicking the region tag to see the details.
(example to be added)Even code with regions can get out hand when there are a large number of regions. Then it is time to group the regions into regions.
Making code readable is an important consideration when developing and maintaining code. The single best way to make code more organized, thus more readable, is to use "region" compiler directive. Regions effectively group your code into sections and chapters.
This is a simple example of code without the region directive. The code is all there but even with just a few lines it can be difficult to read because nothing stands out. This only gets worse when the class is hundreds or thousands lines long.Here is the same code with regions. It just looks a lot cleaner.Now when you have found the selection that you want it is simply a matter of double clicking the region tag to see the details.(example to be added)Even code with regions can get out hand when there are a large number of regions. Then it is time to group the regions into regions.
Labels: C Sharp, CodingGuideline C#, Visual Studio
Subscribe to Posts [Atom]
