10 ways to make your code rock

@martincronje Solutions Architect and Agile Coach www.metagen.co.za 10 ways to make your code rock TRACK: COMMUNITY SESSIONS

rule[0]; its not about the cool tech its about fundamentals

rule[1]; “switch” and “if” are evil structure vs. behaviour

publicvoidGeneratePayslip(Employee employee) { var salary = CalculateGrossSalary(employee); // do some other stuff } publicdecimalCalculateGrossSalary(Employee employee) { switch (employee.Type) { caseEmployeeType.Permanent: if (DateTime.Today.Month == Calendar.YearEnd) // bonus month returnemployee.BaseSalary + (employee.PerformanceRating*employee.Bonus); else returnemployee.BaseSalary; caseEmployeeType.Contractor: returnemployee.HourlyRate * employee.TimeSheet.TotalHoursWorked; default: thrownewArgumentOutOfRangeException(); } }

publicabstractclassEmployee { publicabstractdecimalCalculateGrossSalary(); } publicclassContractor : Employee { publicoverridedecimalCalculateGrossSalary() { returnHourlyRate * TimeSheet.TotalHoursWorked; } // properties and stuff } publicclassPermanent : Employee { publicoverridedecimalCalculateGrossSalary() { if (DateTime.Today.Month == Calendar.YearEnd) // bonus month returnBaseSalary + (PerformanceRating * Bonus); returnBaseSalary; } // properties and stuff }

publicvoidGeneratePayslip(Employee employee) { var salary = employee.CalculateGrossSalary(); // do some other stuff }

rule[2]; comments are bad… mostly bad code needs explanation

publicclassSomeClass { ///<summary> /// Returns a boolean to indicate whether a class is /// in read-only mode or not. ///</summary> publicboolReadOnly { get; set; } }

///<summary> /// Helper class to find the shorted path within the graph from one point to /// another. ///</summary> publicclassShortestPath { ///<summary> /// Find the shortest path within the graph from one point to another. /// This method makes used of Dijkstra's algorithm to find the path. ///</summary> ///<param name="point1">GraphNode representing the starting point</param> ///<param name="point2">GraphNode representing the end point</param> ///<returns>The shortest path between two points.</returns> publicStack Calculate(GraphNode point1, GraphNode point2) { // do stuff } }

///<summary> /// Non-recursive implementation of Dijkstra’s shortest path. This class is /// not thread-safe. (Ref: http://en.wikipedia.org/wiki/Dijkstra's_algorithm) ///</summary> publicclassDijsktraShortestPath : IShortestPath { publicStack Find(GraphNodestartNode, GraphNodeendNode) { // do stuff } }

publicclassUserManagement { publicvoid Register(UserProfile profile) { // Throw exception if the user exists if (_repository.Load(profile.ClaimIdentifier) != null) { thrownewUserAlreadyExistsException(profile); } _repository.Store(profile); } // other stuff }

publicclassUserManagement { publicvoid Register(UserProfile profile) { if (UserExists(profile)) { thrownewUserAlreadyExistsException(profile); } _repository.Store(profile); } privateboolUserExists(UserProfile profile) { return _repository.Load(profile.ClaimIdentifier) != null; } // other stuff }

rule[3]; understandability 4 line rule

rule[4]; don’t repeat yourself don’t repeat yourself

rule[5]; code reviews never happen static code analysis / pair programming

rule[6]; don’t underestimate the power of TDD young Skywalker

rule[7]; use frameworks don’t build them

It looks like you are writing a framework. What do you want to do? Delete all code Looks for something online Find a new job Neal Ford – 10 ways to improve your code

rule[8]; premature optimisation is the root of all evil

rule[9]; understand quality …and purpose

Overview “97 Things Every Programmer Should Know”,O'Reilly Media Robert C. Martin, “Clean Code - A Handbook of Agile Software Craftsmanship”, Prentice Hall Martin Fowler, “Refactoring-Improving The Design Of Existing Code”, Addison-Wesley Steve McConnell, “Code Complete - A Practical Handbook Of Software Construction”, Microsoft Press Krzysztof Cwalina, Brad Abrams, “Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries”, Addison-Wesley(http://msdn.microsoft.com/en-us/library/ms229042.aspx)

Keep in Touch facebook.com/msdevsa @msdevsa http://blogs.msdn.com/southafrica

Don’t forget the Kinect show- down after sessions this evening!

DevDays 2011 Sponsors PLATINUM SPONSOR www.bbd.co.za SILVER SPONSOR www.dvt.co.za SILVER SPONSOR www.ctutraining.co.za

© 2008 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries. The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

10 ways to make your code rock

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (18)

Similar to 10 ways to make your code rock

Similar to 10 ways to make your code rock (20)

Recently uploaded

Recently uploaded (20)

10 ways to make your code rock