Skip to main content

Your Code Is Broken If You Don't Understand It

If you don't understand every line of code you write, your code is broken!

Ever start writing a pice of code, and it snowballs on you and you end up with a couple hundred (or thousand) lines of code, and it starts to get away from you? You start wondering what it all means? Maybe you're working with other developers, with various levels of experience, which is adding to the overall code mass. Collectively do you understand what you are writing?

If at any point you stop being able to understand the code you are writing, it's time to stop and rethink  things. The code is broken. Now is the time to correct it!

A problem you perceive is a problem you own!

If there's something bothering you about your code base, there's no better time than the present to address it. It doesn't matter your seniority level. You should talk it through with other devs. Maybe they have similar problems with the code, but we're hesitant to bring it up. Continuously thinking about talking about, and improving your systems is the only way to keep your systems functioning. Putting off problems will only cost you more in the future!

From my experience, good code is boring code. Good good is self explanatory. Good code is modularized. Good code reads well. Good code matches up with the domain concepts. Writing good code takes time, patience, and access to experience developers who know what good code is and how to write it. Good code is hard to do, but worth the effort if you ever want to maintain it.

Writing good code is possible even under time pressure! Stress is no excuse for sloppiness!

If at any point you notice you can't understand the code, it's usually an indication that you are heading down the wrong path!

There is usually a simpler way!

When you recognize that you're code is getting to complicated, stop and think. Why is this so complicated? Is the complexity inherent to the domain? If not, then most likely it's incidental complexity.

The best thing you can do if you ever get this point is to talk it through with someone else!

The act of explaining things to someone else helps solidify in our minds what we're trying to accomplish.

Ever feel the need to write comments in your code such as

// hackety hack hack, this is a hack

? If you ever feel that need, stop. You know that your code us getting away from you. It's talking to you. Don't write that comment and carry on. While the business wants results, they also don't want to carry around a liability!

And what value to future maintainers do such comments provide? Every line of code, every character you type should have a reason, and a dam good one. The code should be clean, and as simple and straightforward as possible.

The single responsibility principle and the don't repeat yourself principle applied religiously go a long way to improving the maintainability of your code. In my experience, they aren't applied enough!

Ok, kind of a rantish vibe emerging.

To end this on a positive note, apply the 4 XP simplicity rules, and take pride in your work! Also, check out an answer I posted on Quora which has lots of links to great talks and books that I have found the most valuable.

I highly recommend you watch Rich Hickey's talk "Simple Made Easy".

Update

I just watched Uncle Bobs talk " The Last Programming Language" on InfoQ, and it fits really well into this post.

Uncle Bob talks about the divide between business and engineering, and I believe this divide does indeed exist. Deeply technical engineering work is necessary to deliver long lasting results, but it doesn't fit very well into high level business metrics.

Also, the developers and engineers who understand what it really takes to deliver quality software can have a hard time selling the costs of doing things "right". And on top of that, we developers and engineers don't agree on what " right" really means.

Comments

Popular posts from this blog

Generating Java Mixed Mode Flame Graphs

Overview I've seen Brendan Gregg's talk on generating mixed-mode flame graphs and I wanted to reproduce those flamegraphs for myself. Setting up the tools is a little bit of work, so I wanted to capture those steps. Check out the Java in Flames post on the Netflix blog for more information.

I've created github repo (github.com/jerometerry/perf)  that contains the scripts used to get this going, including a Vagrantfile, and JMeter Test Plan.

Here's a flame graph I generated while applying load (via JMeter) to the basic arithmetic Tomcat sample application. All the green stacks are Java code, red stacks are kernel code, and yellow stacks are C++ code. The big green pile on the right is all the Tomcat Java code that's being run.


Tools Here's the technologies I used (I'm writing this on a Mac).
VirtualBox 5.1.12Vagrant 1.9.1bento/ubuntu-16.04 (kernel 4.4.0-38)Tomcat 7.0.68JMeter 3.1OpenJDK 8 1.8.111linux-tools-4.4.0-38linux-tools-commonBrendan Gregg's Fla…

Basic Web Performance Testing With JMeter and Gatling

Introduction In this post I'll give a quick way to get some basic web performance metrics using both JMeter and Gatling.

JMeter is a well known, open source, Java based tool for performance testing. It has a lot of features, and can be a little confusing at first. Scripts (aka Test Plans), are XML documents, edited using the JMeter GUI.  There are lots of options, supports a wide variety of protocols, and produces some OK looking graphs and reports.

Gatling is a lesser known tool, but I really like it. It's a Scala based tool, with scripts written in a nice DSL. While the scripts require some basic Scala, they are fairly easy to understand and modify. The output is a nice looking, interactive, HTML page.
Metrics Below are the basic metrics gathered by both JMeter and Gatling. If you are just starting performance testing, these might be a good starting point.

Response Time – Difference between time when request was sent and time when response has been fully received

Latency –…

Multi Threaded NUnit Tests

Recently I needed to reproduce an Entity Framework deadlock issue. The test needed to run in NUnit, and involved firing off two separate threads. The trouble is that in NUnit, exceptions in threads terminate the parent thread without failing the test.

For example, here's a test that starts two threads: the first thread simply logs to the console, while the other thread turfs an exception. What I expected was that this test should fail. However, the test actually passes.

readonly ThreadStart[] delegates = { () => { Console.WriteLine("Nothing to see here"); }, () => { throw new InvalidOperationException("Blow up"); } }; [Test] public void SimpleMultiThreading() { var threads = delegates.Select(d => new Thread(d)).ToList(); foreach (var t in threads) { t.Start(); } foreach (var t in threads) { t.Join(); } }
Peter Provost posted an article that describes how to make this test fail. It works…