Object Mentor Blog: Clean Code. Whew!

Clean Code. Whew!

Uncle Bob — Tue, 08 Apr 2008 00:10:16 -0500

I’ve been working on this book for several years now. After a flurry of effort (you might have noticed I’ve been quiet lately) I’m very pleased to say that I’m done with the writing and am preparing the manuscript for production. See The Prentice Hall Listing

Table of Contents

Clean Code    1
    There Will Be Code    1
    Bad Code    2
    The Total Cost of Owning a Mess.    3
    Schools of Thought.    11
    We are Authors.    12
    The Boy Scout Rule    13
    Prequel and Principles    14
    Conclusion    14
    Bibliography    15
Meaningful Names by Tim Ottinger    17
    Introduction    17
    Use Intention-revealing Names    17
    Avoid Disinformation    19
    Make Meaningful Distinctions    20
    Use Pronounceable Names    21
    Use Searchable Names    22
    Avoid Encodings    23
    Avoid Mental Mapping    24
    Class Names    25
    Method Names    25
    Don't Be Cute    25
    Pick One Word Per Concept    26
    Don't Pun    26
    Use Solution Domain Names    27
    Use Problem Domain Names    27
    Add Meaningful Context    27
    Don't add Gratuitous Context    29
    Final Words ...    30
Functions    31
    Small!    34
    Do one thing.    35
    One level of abstraction per function.    36
    Switch Statements.    37
    Use descriptive names.    39
    Function Arguments.    39
    Have no side-effects.    43
    Command Query Separation    44
    Prefer exceptions to returning error codes.    45
    Don't Repeat Yourself.    47
    Structured Programming    48
    How do you write functions like this?    48
    Conclusion    49
    SetupTeardownIncluder    49
    Bibliography    52
Comments    53
    Comments do not make up for bad code.    55
    Explain yourself in code.    55
    Good Comments    55
    Bad Comments    59
    Example    71
    Bibliography    74
Formatting    75
    The Purpose of Formatting    76
    Vertical Formatting    76
    Horizontal Formatting    84
    Team Rules    89
    Uncle Bob's Formatting Rules.    90
Objects and Data Structures    93
    Data Abstraction    93
    Data/Object anti-symmetry.    95
    The Law of Demeter    97
    Data Transfer Objects    99
    Conclusion    101
    Bibliography    101
Error Handling by Michael Feathers    103
    Use Exceptions Rather than Return Codes    103
    Write Your Try-Catch-Finally Statement First    105
    Use Unchecked Exceptions    106
    Provide Context with Exceptions    107
    Define Exception Classes In Terms of a Caller's Needs.    107
    Define the Normal Flow    109
    Don't Return Null    110
    Don't Pass Null    111
    Conclusion    112
    Bibliography    112
Boundaries by James Grenning    113
    Bibliography    119
Unit Tests    121
    The Three Laws of TDD    122
    Keeping Tests Clean    123
    Clean Tests    124
    One Assert per Test    129
    F.I.R.S.T.    132
    Conclusion    132
    Bibliography    133
Classes    135
    Class Organization    135
    Classes should be Small!    136
    Organizing for Change    146
    Bibliography    150
Systems    By Dean Wampler 151
    How would you build a city?    151
    Separate constructing a system from using it    152
    Scaling Up    155
    Java Proxies    158
    Pure Java AOP Frameworks    160
    AspectJ Aspects    163
    Test-drive the system architecture    164
    Optimize decision making    165
    Use standards wisely, when they add demonstrable value    165
    Systems need Domain-Specific Languages    166
    Conclusion    166
    Bibliography    167
Emergence By Jeff Langr    169
    Getting Clean via Emergent Design    169
    Simple Design Rule 1: Runs all the tests    170
    Simple Design Rules 2-4: Refactoring    170
    No Duplication    170
    Expressive    173
    Minimal Classes and Methods    174
    Conclusion    174
    Bibliography    174
Concurrency    by Brett Schuchert 175
    Why Concurrency?    176
    Challenges    177
    Concurrency Defense Principles    178
    Know Your Library    180
    Know Your Execution Models    181
    Beware Dependencies between Syncrhonized Methods    182
    Keep Synchronized Sections Small    183
    Writing Correct Shut-Down Code is Hard    183
    Testing Threaded Code    184
    Conclusion    188
    Bibliography    189
Successive Refinement    191
    Args Implementation    192
    Args: the rough draft.    198
    String Arguments    212
     Conclusion    246
JUnit Internals    249
    Conclusion    262
Refactoring SerialDate    263
    Conclusion    280
    Bibliography    281
Smells and Heuristics    283
    Comments    283
    Environment    284
    Functions    285
    General    285
    Java    304
    Names    306
    Tests    310
    Conclusion    311
    Bibliography    312
Concurrency II    by Brett Schuchert 313
    Client/Server Example    313
    Possible Paths of Execution    317
    Knowing Your Library    322
    Dependencies between methods can break concurrent code    325
    Increasing Throughput    329
    Deadlock    331
    Testing Multi-Threaded Code    335
    Tool Support for Testing Thread-Based Code    337
    Conclusion    338
    Tutorial: Full Code Examples    339
org.jfree.date.SerialDate    345
Cross References of Heuristics    406

"Clean Code. Whew!" by Artist managment

Wed, 08 Feb 2012 15:59:07 -0600

Take your online presence to the next level with Audio Dynamix Sound & Design – offering services to leverage and engage your growing audience with Professional Mixing & Mastering Services, and elegantly designed websites optimized for social interactions & mobile viewing.

Having an online presence beyond facebook and twitter establishes yourself as a business/brand and helps maximize your online social presence. This puts you on a platform to be taken more seriously by label representatives and A&R’s.

Audio Dynamix Sound & Design offers: - Website Design/Consultation - Artist Management & Resources

Please see our blog below and don’t hesitate to contact us with any questions:

"Clean Code. Whew!" by service apartment singapore

Wed, 08 Feb 2012 05:29:28 -0600

Thanks for this post. It Very nice article. It was a very good article. I like it. Thanks for sharing. Ask you to share good article again.

"Clean Code. Whew!" by drucker

Tue, 07 Feb 2012 07:40:49 -0600

Thanks for the information in this blog. I am sure that your visitors will enjoy this post just as much as I did.

"Clean Code. Whew!" by Aaron

Tue, 07 Feb 2012 06:21:06 -0600

You know, content area is one of the most overlooked about areas of a site when it comes to a style. However, it is also a very essential area as far as making a group goes.

"Clean Code. Whew!" by actividades culturales Madrid

Mon, 06 Feb 2012 15:37:07 -0600

I just got to this amazing site not long ago. I was actually captured with the piece of resources you have got here. Big thumbs up for making such wonderful blog page!

"Clean Code. Whew!" by www.fiberinternetprovider.com

Mon, 06 Feb 2012 09:57:16 -0600

WOW! What a book! So useful and very informative… even a non-pro whizkids can understand this book! Thanks Bob!

"Clean Code. Whew!" by Security Companies Birmingham

Mon, 06 Feb 2012 05:54:03 -0600

Hi everyone. after readig this article I can say that it is really a knowledgeable post. I have been in search of this topic and got the best today!

"Clean Code. Whew!" by ooglaseren

Sun, 05 Feb 2012 23:17:41 -0600

Its been wow reading your article. I would like to jump on this site again.This information is excellent, as share good stuff with good concept

"Clean Code. Whew!" by Brfo

Sun, 05 Feb 2012 20:00:59 -0600

Thanks for the nice blog. It was very useful for me. Keep sharing such ideas in the future as well. This was actually what I was looking for, and I am glad to come here! Thanks for sharing the information with us.

"Clean Code. Whew!" by Forfait mobile

Sun, 05 Feb 2012 15:17:00 -0600

You stated that you don’t like the author’s statement on ActiveRecord. But you did not state * why * you don’t like his statement.

"Clean Code. Whew!" by rocks2010

Sat, 04 Feb 2012 16:16:06 -0600

Our Will writing service is a fast, cost-effective and quality service. We provide our expert bespoke Will writing service at highly competitive prices. Mother’s Day Flowers

"Clean Code. Whew!" by Versicherungsbüro

Sat, 04 Feb 2012 15:39:46 -0600

After reading this article, I am going to recommend others to read it as well, since I know they will enjoy it as much as I did.

"Clean Code. Whew!" by hekwerken

Sat, 04 Feb 2012 00:07:59 -0600

Luchthaven Schiphol parkeren? Vergelijk parkeren schiphol en parkeer voordelig. Goedkoop parkeren Schiphol. Zie ook lang parkeren Schiphol aanbieders.

"Clean Code. Whew!" by Rumah

Fri, 03 Feb 2012 01:28:14 -0600

I always looking for these kind of sites..This site gives me lots of unique information which i exactly want..

"Clean Code. Whew!" by Print Flyers

Wed, 01 Feb 2012 23:59:50 -0600

I always follows this site on tweeter..This site is one of best informative site..!

"Clean Code. Whew!" by Will Writers Hull

Wed, 01 Feb 2012 12:28:09 -0600

Our Will writing service is a fast, cost-effective and quality service. We provide our expert bespoke Will writing service at highly competitive prices.

"Clean Code. Whew!" by flowers

Wed, 01 Feb 2012 09:44:52 -0600

Wow! I really loved reading your blog. It was very well written and simple to understand. Unlike additional blog. I have read.

"Clean Code. Whew!" by günstig Urlaub machen

Wed, 01 Feb 2012 06:27:19 -0600

I will really appreciate the writer’s selection for choosing this great article.Here is deep description about the article’s tittle.

"Clean Code. Whew!" by ljubavni stihovi

Wed, 01 Feb 2012 05:35:40 -0600

Excellent post is written here. I want to thank you for this informative read. I will bookmark this site and visit again..

"Clean Code. Whew!" by bank career

Tue, 31 Jan 2012 23:53:20 -0600

This article gives the light in which we can observe the reality. This is very nice one and gives indepth information. Thanks for this nice article.

"Clean Code. Whew!" by Carl

Tue, 31 Jan 2012 16:52:38 -0600

Thanks for taking the time to discuss this matter. I’ve read some excellent stuff here, great site. cd aufnehmen

"Clean Code. Whew!" by Smart Repair

Tue, 31 Jan 2012 14:26:51 -0600

With all the sites out there with almost useless information it’s nice to find a blog whose admin takes the time to create good material

"Clean Code. Whew!" by hunza

Tue, 31 Jan 2012 12:57:15 -0600

When virtue and modesty enlighten her charms, the lustre of a beautiful woman is brighter than the stars of heaven, and the influence of her power it is in vain to resist. web design company new york

"Clean Code. Whew!" by restaurants in savannah ga

Mon, 30 Jan 2012 12:26:52 -0600

This series of Clean code is the best one i should suggest!

"Clean Code. Whew!" by Steve Waters Vancouver

Sun, 29 Jan 2012 21:17:43 -0600

A random act of kindness!