Webcast: Implementing Microsoft Design Guidelines with CodeIt.Right

Microsoft Design Guidelines
with CodeIt.Right
6/3/2014
http://submain.com/webcasts/microsoft-design-guidelines-with-codeit.right/
for the webcast recording and slides download

Webcast Housekeeping
6/3/2014
Audio
 Connect viaVoIP
 Plug in a headset or turn up your speakers
 Select “Headset/Mic” inAudio Options
 Connect via Phone
 Select “Dial In” in Audio Options
 Call 1 (949) 229-4400
 PIN: 1066921#
Asking A Question
 Use the Ask a Question button in the top left corner
 Questions will be addressed at the end of the webcast
Recording
 A recording download link will be sent to all registrants within a few days
Copyright © SubMain 2014 2

Introduction
Presenter
David McCarter
Microsoft MVP
(g)host
Serge Baranovsky
Principal, SubMain
6/3/2014 Copyright © SubMain 2014 3

David McCarter
dotnetdave@live.com
 C# Microsoft MVP
 Developer/ Architect/ Consultant &
Professional Code Reviewer
 RockThe Nation ConferenceTour
 http://bit.ly/dNdRTNT
 David McCarter’s .NET
Coding Standards
 http://bit.ly/dpmbooks
 dotNetTips.com
 700+Tips,Tricks, Articles, Links!
 Open Source Projects:
 CODEPLEX.COM/DOTNETTIPS
6/3/2014
@realdotnetdave davidmccarter

Why We Need Coding
Standards (Guidelines)

Benefits
 Code Clarity/Easier to Understand
 Easier to Maintain
 Reduce Bugs
 SimplifyCode Reviews
 Shorter learning curve for new team members
 Consistency across large and distributed teams
 Comply with internal or regulatory quality initiatives
 Produces more stable and reliable code

Business Benefits
 Improve software quality
 Accelerate time to market
 Enhance customer satisfaction
 Reduce long term cost
 Improve productivity

Why Coding Standards Fail
35%
23%
26%
10%
6%
Developers kept forgetting to abide the
guidelines
Resistance among the team members
Couldn't get a concensus on which standard
to follow
Management thought is was too expensive
and not worth the investment
Other
6/3/2014
Source: SubMain survey of developers and teams

Implement Coding Standards
6/3/2014
1. Get the business owner’s buy-in
2. Get initial consensus
3. Choose a base standard to follow
a. Customize the standard (optional)
4. Create our own team guidelines document
a. Prioritize what’s most important
5. Implement Code Reviews
6. Use code generation
7. Review status and give feedback
http://submain.com/webcasts/coding-standards-in-the-real-world/
for the webcast recording, slides and ebook download

Overview

Overview
Guidelines for designing libraries that interact with the .NET
Framework
 Most code should be in DLL’s (libraries), not in the application
 http://submain.com/fwlink/std/ms
Most popular coding standard among C# andVB teams
Not just for frameworks and libraries
Unified programming model
Microsoft uses for .NET Framework itself
Guidelines are organized:
 Do, Consider, Avoid, Do Not

Categories
 Naming Guidelines
 Naming assemblies, namespaces, types,
and members in class libraries
 Type Design Guidelines
 Using static and abstract classes,
interfaces, enumerations, structures, and
other types
 Member Design Guidelines
 Designing and using properties, methods,
constructors, fields, events, operators,
and parameters
 Designing for Extensibility
 Subclassing, using events, virtual
members, and callbacks, and explains
how to choose the mechanisms that best
meet your framework's requirements
6/3/2014
 Design Guidelines for Exceptions
 Designing, throwing, and catching
exceptions
 Usage Guidelines
 Using common types such as arrays,
attributes, and collections, supporting
serialization, and overloading equality
operators
 Common Design Patterns
 Choosing and implementing dependency
properties and the dispose pattern

What is CodeIt.Right
 Automated way to ensure your source code adheres to
 (your) predefined design requirements
 style guidelines
 best coding practices
 Static Code Analysis and Metrics
 Automatic and safe refactoring
of issues into conforming code
 Automated Code Review process

What is CodeIt.Right - continued
Instant Code Review – real-time code checking
OnDemand Analysis
Source Control Check-In Policy
Build Process Integration
Hundreds of rules
 Security, Performance, Usage,
Design, Maintainability,
Exception Handling,
Globalization,
Async, and more

Naming Guidelines
Capitalization Rules
 PascalCasing – used on all public member, type & namespaces
 camelCasing – parameter names
 Use “_” (underscore) to prefix private field names. Not “m_”.
Namespaces and Assemblies
 <Company>.(<Product>|<Technology>)[.<Feature>][.<Subnamespace>]
 Microsoft.Advertising.Mobile.UI
 dotNetTips.Utility.Portable.Windows.Extensions
Don’t forget about spelling of types! Can’t be changed
(easily) after going into production.

Type Design Guidelines
Leave at default type of Int32
Enum default value
 Use the value 0 and set it to a “not chosen” value
6/3/2014
Public Enum WorkItemStatus
Undetermined
Completed
Queued
Executing
Aborted
End Enum
0 value

Member Design Guidelines
Do not call code from constructor
 Only set parameters
Incorrect
6/3/2014
public class FileCache
{
public FileCache()
{
var cacheDir =
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
if (Directory.Exists(cacheDir) == false)
{
Directory.CreateDirectory(cacheDir);
}
}
}

Member Design Guidelines
Do not call code from constructor
 Only set parameters
Correct
6/3/2014
public class FileCache
{
public string FilePath {get; private set};
public FileCache(string path)
{
this.FilePath = path;
}
}
No code called

Designing for Extensibility
SealedClasses
 Don’t seal classes unless they are:
 Static class
 Stores sensitive data
 Inherits many virtual members (makes sealing members easier)
 Class is an attribute that requires fast runtime look-up
 Sealed classes could provide some performance
improvement but limits developers from inheriting that
type
 Do not declare protected members
 Used for inheritance only
6/3/2014
public sealed class Person {}

Design Guidelines for Exceptions
Use the “newer”TryParse method on value types to
avoid Exceptions
6/3/2014
DateTime dateValue
if (DateTime.TryParse("11/11/14", out dateValue))
{
Console.WriteLine("{0}).", dateValue);
}
else
{
Console.WriteLine("Unable to parse string.");
}

Usage Guidelines
Overload Equality & Hashtag Operators onTypes
6/3/2014
class Point
{
protected int x, y;
public Point(int xValue, int yValue)
{ x = xValue; y = yValue; }
public override bool Equals(Object obj)
{
if (obj == null || GetType() != obj.GetType())
{return false;}
Point p = (Point)obj;
return (x == p.x) && (y == p.y);
}
public override int GetHashCode()
{ return x ^ y; }
}

Common Design Patterns
6/3/2014
using(var sqlDataReader = new SqlDataReader)
{
//SqlDataReader code goes here
using(var connection = new SqlConnection)
{
//SqlConnection code goes here
using(var BMSConnection = new SqlConnection)
{
//SqlConnection codes here
}
}
}
 Make sure you call
Dispose on types that
implement
IDisposable!
 Can create virtual
memory leaks
• Use the “using”
statement
Calls Dispose on BMSConnection
Calls Dispose on connection
Calls Dispose on sqlDataReader

Common Design Patterns - continued
6/3/2014
public class Base: IDisposable
{
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (disposing) { // Free other state (managed objects) }
}
~Base()
{
Dispose (false);
}
}
• Implement
IDisposable type
• To ensure resources
are cleaned up
SignalsGarbageCollector
GarbageCollectorWill Call

Notes forVB Developers
Enable Object Strict
 Insures strict object checking is on… just like it always is on in C#
NO Goto statements!
Use Exit statements
 Exit Do
 ExitWhile
 Exit For
 Exit Sub, Function
6/3/2014
Dim sum as Integer
Dim number as Integer
Do
number = number + 1
sum = sum + number
If number = 100
Exit Do
End If
Loop

And not onlyVB Developers
Use Case instead of chains of If statements
6/3/2014
If value = 1 Then
‘’ Do work
Else If value = 2 Then
‘’ Do Work
Else If value = 3 Then
‘’ Do Work
End If
Select Case value
Case 1
‘’ Do work
Case 2
‘’ Do work
Case 3
‘’ Do work
End Select
SelectCase
 Put the normal case first - both more readable and more efficient
 Order cases by frequency - cases evaluated in the order that they appear in the
code

Refactoring to Patterns - CodeIt.Right

Serialization Pattern - Demo
Not as easy as you might think
Any class that might be serialized must be marked with
SerializableAttribute
 Applies to serializing to disk, via a service
To control serialization process implement ISerializable
 Implement GetObjectData
 Populates SerializationInfo with data needed to serialize object
There is more to do it properly…

Asynchronous Programming
Microsoft Async – originally designed for EAP – “event-
based pattern” – no more, don’t do that!
Current Microsoft Async implementation isTAP – “task-
based async pattern”
Best practices – useTAP not EAP
 Don’t create “Async Sub” methods (aka void-returning asyncs) except for
top-level event handlers
 Call an API that returns aTask? Almost always await it either immediately or
later
 Async methods should have the suffix “Async” and returnTask orTask<T>
 Async method contains only one await operator? (“return await <expr>”)
then “return <expr>” and make your method non-async
Easy way to still shoot yourself in the foot!

Asynchronous Programming – contd.
Async confusing? CodeIt.Right will guide
 CodeIt.Right Async rule set:
 Async method should have "Async" suffix
 Async method should have await statement
 Async method should returnTask orTask<T>
 Async method - avoid "out" and "ref" parameters
 Async method - await for completion
 Await statement - method should be async
 Async method - call Start on theTask
 Async method - do not useTask.Yield
 Async method - do not useTask.Wait
 Async method should not be Sub
 Async method parameters should be the same to synchronous counterpart
 Async method - transform to non-async if simple

ASP.NET/Security
 Do not disable custom errors
 Disable anonymous access
 EnableEventValidation should beTrue
 ValidateRequest should beTrue
 ViewStateEncryptionMode should be Always
 EnableViewStateMac should beTrue
 EnableViewState should beTrue
 Compilation Debug should be False
 Form authentication should not contain credentials
 Disable form authentication EnableCrossAppRedirects
 Form authentication RequireSSL should beTrue
 Form authentication SlidingExpiration should be False
 Http cookies HttpOnlyCookies should beTrue
 Http cookies RequireSSL should beTrue
 Trace should be disabled
 Role manager CookieProtection should beAll
 Role manager CookieSlidingExpiration should be False
 Page EnableViewStateMac should beTrue
 Page EnableEventValidation should beTrue
 Http runtime EnableHeaderChecking should beTrue
6/3/2014
 Custom error DefaultRedirect should be specified
 Always define a global error handler
 PageValidateRequest should beTrue
 PageViewStateEncryptionMode should beAlways
 Form authentication Protection should beAll
 Avoid the DataBinder.Eval method
 Avoid the Page.DataBind method
 Avoid setting theAutoPostBack property toTrue
 Do not use deprecated properties of Response object
 Do not use SaveAs method to store uploaded files
 MVC controller action -> UseValidateAntiforgeryTokenAttribute
 MVC controller action -> Enable request validation
 Review deny and permit only usage
 Review visible event handlers
 GetObjectData is not marked with SecurityPermissionAttribute
 Secure serialization constructors
 Should have identical link demands to base method
 Wrap vulnerable finally clauses in outer try
 Type, Security transparent code should not assert
 and more – 54 in total!
No worries – we’ve got you covered!
Just the ASP.NET/Security category:

CodeIt.Right Benefits
Improve Product Quality at the Source
Comply with internal or regulatory quality initiatives
Decrease the cost and time of Code Reviews
Reduce QA testing and focus
on meeting requirements
Continuous Code Quality Solution

Q&A
Questions?
Email - customer-service@submain.com
Video - submain.com/codeit.right/video
Download the free CodeIt.Right trial at submain.com/codeit.right
Contact David McCarter: dotnetdave@live.com
6/3/2014
1 (800) 936-2134
http://submain.com/webcasts/microsoft-design-guidelines-with-codeit.right/
for the webcast recording and slides download

Webcast: Implementing Microsoft Design Guidelines with CodeIt.Right

Recommandé

Recommandé

Contenu connexe

Dernier

Dernier (20)

En vedette

En vedette (20)

Webcast: Implementing Microsoft Design Guidelines with CodeIt.Right