Posts Tagged: software quality

Home » software quality

A Guide to Refactoring Large Functions by Robert Muth

Software Engineer Robert Muth wrote this interesting article on refactoring large functions. The article starts with providing ample motivation for using functions (or methods in a strictly object-oriented context). Apart from making code shareable and reusable, which is only a minor benefit of functions / methods, reasons for writing code as functions are: giving a meaningful name to several lines of related code readability limiting visibility lowering indentation levels improving testability The article goes on to describe several common cues indicating that extracting the code at hand to ... Read more

Kent Beck’s Novel Approach to Software Quality: test && commit || revert

In a Hanselminutes episode from December last year I heard preeminent programmer and agile advocate Kent Beck talk about his intriguing approach to creating working, high-quality code. In line with the steps this approach involves he calls it test && commit || revert. In lieu of the TDD circle of life (write test - test fails - write code - test passes - refactor - test fails ...) test && commit || revert has you commit each time when after a code ... Read more

Angular Checklist

Angular Checklist is a useful tool that allows you to compile checklists of best practices, common mistakes and other aspects to consider both before launching a new app and during ongoing development. Although the tool's name and the default checklist suggest Angular-only usage this checklist tool of course is applicable to other frameworks, too. Read more

Dependency Management for Angular Unit Tests Using TestModuleMetadata

Since its inception it's always been one of the eminent design goals of Angular (and AngularJS before it) to make JavaScript applications easily testable and bake unit and E2E testing right into the development process. While the Angular team certainly has succeeded at this there's still the occasional snag you hit when writing unit or end-to-end tests. For the most part, the testing experience with Angular is terrific and testing JavaScript codebases has come a long way but of course there's always ... Read more

The 5 Levels of Logging Explained by Orhan Kavrakoğlu

In this article Orhan Kavrakoğlu explains the logging levels commonly used in software alongside with some pertinent examples as well as recommendations and best practices such as in which case to use which particular log level and how to present them to the target audience (i.e. other developers, system administrators or DevOps people) so they get noticed in accordance with their respective importance and urgency. As mentioned here before seemingly trivial improvements such as providing better context in your log messages can ... Read more

Artur Śmiarowski’s Guidelines for Writing Readable Code

Code means communication has become a bit of a mantra for me. Source code isn't just the means by which you translate requirements into commands and structures a machine can understand. Source code also communicates your intent as a designer and engineer as to what a particular piece of software is supposed to do. If written in a clear and comprehensible manner code can serve as an authoritative design specification with no or little extra documentation needed. I would go as far as ... Read more

Tool Suggestion – NGD: Angular Dependencies Graph

When working on a larger codebase knowing about the dependencies between components is crucial, particularly so when you're trying to understand how an existing application works. NGD - Angular Dependencies Graph (part of the Compodoc documentation suite for Angular) is a tool that - as the name suggests - generates dependency graphs (i.e. boxes and arrows) for Angular applications. Dependency graphs give you a high-level overview of an application's architecture and hence are a great first step in understanding how an application ... Read more

Article Suggestion: “Provide Contextual Information in Log Messages”

Software developer Tom Hombergs recently wrote an article about making log statements more useful by providing context in order to make it easier for a developer who uses your libraries or builds upon your code to find out what the actual cause of an error is. The blog post contains many pertinent examples of both good and bad log output. Seemingly trivial improvements such as making your log output more helpful and explicit can make a huge difference and save a lot of ... Read more

On Writing Unmaintainable Code

Software developer Andrew Yurisich maintains an - ironically - maintainable version of the authoritative guide to unmaintainable code by Roedy Green of Canadian Mind Products. This expansive, tongue-in-cheek how-to teaches developers to make themselves indispensable through writing code only they can understand. Aside from the comical value learning by what not to do can be an extremely useful method. By making sure your code follows none of the guidelines put forward in this how-to you'll already have covered many aspects of writing readable, ... Read more

Things to Consider When Creating a New Business App: A Checklist for Setting up a Java-Based Software Architecture

Software developer Tom Hombergs - a former fellow student of mine - published this useful checklist for setting up Java applications on Reflectoring: A Checklist for setting up a Java-based Software Architecture It covers a wide array of both high and low level aspects of server-side and client-side development as well as architectural concerns. Furthermore, the checklist also has sections on operations, the development process and testing in particular. While some of the details may vary depending on the type of applications you create, ... Read more
Next Page »