write code for the future you - tulsa techfest 2016

Tulsa TechFest 2016 | Fri, Aug 5th, 2016 | OSU - Tulsa | 70+ Speakers, 20+ Tracks & 85+ Sessions!

Please help us!Thank our Sponsors:


Write Code For The Future You

Paul GowerPrincipal Consultant / OwnerLunamark


@paulmgower

Full Disclosure…


@paulmgower

Full Disclosure…Summer 2000


@paulmgower


Obfuscated Perl Contest


@paulmgower


Obfuscated Perl Contest

Mentality was to write “elite code” that was hard to understand


@paulmgower

Trajectory Shift


@paulmgower

Trajectory ShiftFirst job out of college, 2001


@paulmgower

Trajectory ShiftFirst job out of college, 2001Alltel Client/Server University


@paulmgower

Trajectory ShiftFirst job out of college, 2001Alltel Client/Server University

Textbook: Code CompleteDaily Lectures, Labs, and Code Reviews


@paulmgower

Real World Learning


@paulmgower

Real World Learning

Added to project towards end of development


@paulmgower

Real World Learning

Added to project towards end of developmentFixing bugs in code you didn’t write


@paulmgower

Real World Learning

Added to project towards end of developmentFixing bugs in code you didn’t writeThe Mythical Man Month by Fred Brooks


@paulmgower

Maintenance? Not me…


@paulmgower

Maintenance? Not me…

Creating Code30%

Maintaining Code70%


@paulmgower

Who reads code? Not me…


@paulmgower

Who reads code? Not me…Writing Code

10%

Reading Code90%


@paulmgower

Why write code for the reader?


@paulmgower

Sept 1991, Comp.lang.c++ newsgroup discussion



@paulmgower

Sept 1991, Comp.lang.c++ newsgroup discussionWhy not use comma more?



@paulmgower

Sept 1991, Comp.lang.c++ newsgroup discussionWhy not use comma more?Like this:

if (condition)var = value, anothervar = anothervalue;



@paulmgower

Sept 1991, Comp.lang.c++ newsgroup discussionWhy not use comma more?Like this:

if (condition)var = value, anothervar = anothervalue;

However consider this:if (condition)var = value; anothervar = anothervalue;



@paulmgower

“Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live”

John F. Woods


@paulmgower

How To Write Better Code?

@paulmgower


@paulmgower

How To Write Better Code?Code Complete published in 1993, 2004

@paulmgower


@paulmgower


Agile Manifesto signed 2001

@paulmgower


@paulmgower


Agile Manifesto signed 2001

Clean Code book published in 2009

@paulmgower


@paulmgower

Power in Variable Names

Describe the entity it represents


@paulmgower



Easy to understand and read


@paulmgower



Easy to understand and read

Be specific as possible


@paulmgower

Variable Name Examples

Bad Namestotal, ct, checks, CHKTTLvelt, tv, traincd, current, c, datelpp, lines

Good NamesrunningTotal, checkTotaltrainVelocity, velocityInMphcurrentDate, todaysDatelinesPerPage


@paulmgower

Magic Numbers


@paulmgower

Magic Numbers == BADDon’t use magic numbers


@paulmgower


Instead use constants, enums or config


@paulmgower


Instead use constants, enums, or config

Makes code more readable / self documenting


@paulmgower

Don’t Do Thispublic void setPassword(String password){ // don't do this if (password.length() > 7) { throw newInvalidArgumentException("password"); } }


@paulmgower

public void setPassword(String password){ const int MAX_PASSWORD_SIZE = 7; if (password.length() > MAX_PASSWORD_SIZE) { throw new InvalidArgumentException("password"); }}

Use Constants or Configuration


@paulmgower

D.R.Y.


@paulmgower

D.R.Y. (Don’t Repeat Yourself)

Duplication leads to maintenance issues


@paulmgower



Y2K Culprit?


@paulmgower



Y2K Culprit?

“Every piece of knowledge must have a single, unambiguous, authoritative representation within a system”


@paulmgower

Classes: Do One Thing Well


@paulmgower


Each responsibility is an axis of change


@paulmgower



Change is going to happen


@paulmgower



Change is going to happen

Loose Coupling


@paulmgower

More than 1 Responsibility


@paulmgower

Single Responsibility


@paulmgower

Stop Writing Legacy Code


@paulmgower


Legacy Code = Code without Tests


@paulmgower



Great Step-by-step guide


@paulmgower



Great Step-by-step guide

Write unit tests as you use legacy code


@paulmgower

Code Reviews

Author + 2 Reviewers


@paulmgower

Code Reviews


Using “peer pressure”


@paulmgower

Code Reviews


Using “peer pressure”

Encourages collaboration


@paulmgower

Code Reviews Tips

Keep a positive attitude


@paulmgower

Code Reviews Tips

Keep a positive attitudeCheck your ego


@paulmgower

Code Reviews Tips

Keep a positive attitudeCheck your egoReview all code


@paulmgower

Code Reviews Tips

Keep a positive attitudeCheck your egoReview all codeCode Review early and often


@paulmgower

Final Review


@paulmgower

Final ReviewGive better variable names


@paulmgower

Final ReviewGive better variable namesDon’t use magic numbers


@paulmgower

Final ReviewGive better variable namesDon’t use magic numbersKeep your code DRY


@paulmgower

Final ReviewGive better variable namesDon’t use magic numbersKeep your code DRYClasses should do one thing


@paulmgower

Final ReviewGive better variable namesDon’t use magic numbersKeep your code DRYClasses should do one thingWrite Unit Tests


@paulmgower

Final ReviewGive better variable namesDon’t use magic numbersKeep your code DRYClasses should do one thingWrite Unit TestsHave regular Code Reviews


@paulmgower

Questions?

http://lunamark.com

http://bit.ly/ttf2016-wcfy

http://lunamark.com/





@paulmgower

ResourcesThe Mythical Man Month by Frederick P. Brooks Jr (http://www.amazon.com/The-Mythical-Man-Month-Engineering-Anniversary/dp/0201835959) Code Complete by Steve McConnell (http://www.amazon.com/Code-Complete-Practical-Handbook-Construction/dp/0735619670) Clean Code by Robert C. Martin (http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) Working Effectively with Legacy Code by Michael Feathers (http://www.amazon.com/Working-Effectively-Legacy-Michael-Feathers/dp/0131177052) FogCreek Software Blog

Effective Code Reviews - 9 Tips from a Converted Skeptic (http://blog.fogcreek.com/effective-code-reviews-9-tips-from-a-converted-skeptic/) Stop More Bugs with our Code Review Checklist (http://blog.fogcreek.com/increase-defect-detection-with-our-code-review-checklist-example/)

http://www.amazon.com/The-Mythical-Man-Month-Engineering-Anniversary/dp/0201835959



http://www.amazon.com/Code-Complete-Practical-Handbook-Construction/dp/0735619670



http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882



http://www.amazon.com/Working-Effectively-Legacy-Michael-Feathers/dp/0131177052



http://blog.fogcreek.com/effective-code-reviews-9-tips-from-a-converted-skeptic/



http://blog.fogcreek.com/increase-defect-detection-with-our-code-review-checklist-example/



write code for the future you - tulsa techfest 2016

Technology