C# tutorial : Coding Standards / PDF
C# tutorial : Coding Standards / PDF
Table of Contents
----------------------------
Sample of the PDF document
1. Introduction
1.1 Purpose
The purpose of this document is to provide
coding style standards for the development of source code written in C#. Adhering
to a coding style standard is an industry proven best-practice for making team
development more efficient and application maintenance more cost-effective. While
not comprehensive, these guidelines represent the minimum level of standardization
expected in the source code of projects written in C#.
1.2 Scope
This document provides guidance on the formatting,
commenting, naming, and programming style of C# source code and is applicable
to component libraries. web services, web sites, and rich client applications.
1.3 Document Conventions
Example code is shown using the Code font and shows syntax as it would be color coded in Visual Studio’s
code editor.
1.4 Feedback
Feedback on these guidelines is highly encouraged.
Please send any questions or comments to your application architect.
.C# Golden Rules
The following guidelines are applicable
to all aspects C# development:
o Follow the style of existing code. Strive to maintain consistency
within the code base of an application. If further guidance is needed, look to these
guidelines and the .NET framework for clarification and examples.
o Make code as simple and readable as possible. Assume that someone
else will be reading your code.
o Prefer small cohesive classes and methods to large monolithic ones.
o Use a separate file for each class, struct, interface, enumeration,
and del
o Write the comments first. When writing a new method, write the
comments for each step the method will perform before coding a single
statement. These comments will become the headings for each block of code that
gets implemented.
o Use liberal, meaningful comments within each class, method, and block
of code to document the purpose of
the code.
o Mark incomplete code with // TODO: comments. When working with many classes at once, it can be very
easy to lose a train of thought.
o Never hard code “magic” values into code (strings or numbers).
Instead, define constants, static read-only variables, and enumerations or read
the values from configuration or resource files.
o Prefer while and foreach over other available looping constructs when applicable. They are
logically simpler and easier to code and debug.
o Use the StringBuilder class and it’s Append(), AppendFormat(), and
ToString() methods instead of the string concatenation operator (+=) for much
more efficient use of memory.
o Be sure Dispose() gets called on IDisposable objects that you create locally within a method. This is most
commonly done in the finally clause of a try block. It’s done automatically when a using statement is used.
o Nev
o Gaps and exceptions to these guidelines should be discussed and
resolved with your application architect.......
C# tutorial : Coding Standards / PDF
0 commentaires: