continuous code quality improvement

Copyright © 2001-2006 Infor Global SolutionsInfor Confidential

Continuous Code Quality Improvement --Tools & Process

Navigator, 10-Oct-06

2 Copyright © 2001-2006 Infor Global Solutions

Yesterday

Better?


Today

Better!

Continuous Code Quality Improvement

Tools & Process


Tools Summary

Code Quality

Coding Standard

Comment Unit Test

Others…

Fxcop

NcoverNdoc


Tools: Fxcop

Coding Standard Examples Don’t declare visible instance fields Pass base type as parameters Nested type should not be visible

Rule One rule to one coding standard

Fxcop Check code according to rules Rules container Plugable

Introduction


Tools: Fxcop

Our Company’s Coding Standard Method must begin with upper case Const values should never be public Must log an exception as soon as it’s caught

Extended Rule Implement a small set of Rule API Use Fxcop’s Introspection Engine

Extension


Tools: NCover

Accurate unit test coverage Clear indication of where to enhance unit test

Requirement

We expect

We need

An actual and clear statistics like this:MethodName UnitTest CoverageFMDDesignerController.Constructor 100.00%FMDDesignerController.EditNavigatorItems 100.00%FMDDesignerController.CreateNavigatorModel 100.00%FMDDesignerController.SaveNavigatorModel 60.00%FMDDesignerController.SaveItemProperty 0.00%


Tools: NCover

Introduction

Code coverage A measure for software testing

NCover A code coverage tool for .NET

ClassName Code CoverageClassA 30%ClassB 100%ClassC 0%


Tools: NCover

Practice

Extension: NCoverEx Multiple execute in a loop for single assembly Reformat to statistic table and filter output for non-private methods


Tools: NDoc

Complete and clear comments

A statistics of missing common comments Class Declaration Method Declaration

A statistics of missing special comments Whether a parameter or returned value could possibly be null Whether a parameter or returned value could possibly be empty if it is

string type Whether a parameter or returned value could possibly be empty if it is

collection type

Requirement


Tools: NDoc

About Ndoc Generates Documentation for .NET Code Multiple Doc Formats Support Open-Source

Extension

Practice


Process Summary

Fix & Update Status

Discuss

Washup Items

ClaimPublish

Check


Process: Check

One Master for Each Tool

Every Week

Two Phase Phase1 – Partial and Incremental

Fxcop - Sort rules by message level NCover - Missing test classes; Missing test methods NDoc - Fixed count for each component

Phase2 – Select All


Process: Publish & Claim

Uniform Excel Output

Claim Items ASAP by Self Generally by Component Ownership by Primitive Authorship


Process: Fix & Update Status

Must finish by weekend

Fit into daily work by each self freely

Get help or change ownership if necessary

Exclude with reasons


Process: Discuss

Discuss

•On Demand

•After publishing, fix&update, or anytime else

•Lightweight

•Discuss Fxcop rules

•Discuss difficulty in writing unit tests

•Discuss comment standard

•Discuss how to further extend Fxcop/Ndoc/NCover


Conclusion

Yesterday Today

Frequency An Iteration (6 weeks) 1 week

Check Mistakes Manually,

Time-cost,

Limited Results

Auto,

Quick,

All Results by Tools

Fix Mistakes Limited Corrections,

No Review and Track

All Corrected,

Easy to Review&Track

Work Focus Find Mistakes Find/Develop Better Tools and Process

Funny No Yes


Limits

Work Load of Tool Extension

Class TestClass

MethodA

MethodB

TestMethod1

TestMethod2

TestMethod3

More Accurate Unit Test Coverage

Measure & Check of Software Design


Tomorrow

From Weekly To Daily Easy to Append Missing Comments and Unit Test Methods Keep Few Mistakes All Along Ultimately Test-Driven Realized

Big Rule Repository

More and Smarter Tools


Thanks

continuous code quality improvement

Documents