C# 3.0 Coding Guidelines Quick Reference … the caller in mind (AV2306) Do write MSDN-style documentation (AV2307) Do write comments that explain the purpose (the why) of a code block …
C# 3.0 Coding Guidelines Quick Reference Design & Usage March 2009 Dennis Doomen www.avivasolutions.nl blog.avivasolutions.nl Design Don’t hide inherited members with the new keyword (AV1010) It should be possible to treat a derived object as if it were a base class object (AV1010) Do allow properties to be set in any order (AV1015) Don’t create a constructor that does not yield a fully initialized object (AV1020) Don’t return an array (AV1025) String and array properties should never return a null reference (AV1027) Provide a rich and meaningful exception message text (AV1040) Don’t swallow errors by catching non-specific exceptions (AV1042) Prefer throwing existing exceptions (AV1043) Do always check an event handler delegate for null (AV1051) Do use a protected virtual method to raise each event (AV1052) Do only implement casts that operate on the complete object (AV1060) Avoid casting to and from System.Object in code that uses generics (AV1062) Don’t add extension methods to the same namespace as the extended class (AV1070) Do evaluate the result of a LINQ expression before returning it (AV1076) Maintainability Avoid using names that can be mistaken with other names (AV1501) Do name a source file to the class it contains (AV1506) Do limit the contents of a source code file to one class (AV1507) Don’t use “magic numbers” (AV1515) Do use var only when the type is very obvious (AV1520) Do initialize variables at the point of declaration, if possible (AV1521) Favor Object and Collection Initializers over separate statements (AV1523) Do use an enumeration instead of a list of strings if the list of values is finite (AV1526) Do use a block with all flow control keywords, even if it is empty (AV1535) Do code every if-else if statement with an else-part (AV1537) Avoid multiple return statements (AV1540) Prefer conditional statements instead of simple if-else constructs (AV1546) Do explicitly define the scope of a type or member (AV1550) Do implement the most complete overload of a method or constructor and call it from the other overloaded methods or constructors (AV1551) Avoid methods with more than 5 arguments (AV1561) ….
http://www.pdfee.com/c-30-coding-guidelines-quick-reference-design-usage.html
Tags: Programming