KTOWN’s Guide to Readable C Code @ The Adafruit Learning System

Adafruit 3014
KTOWN’s Guide to Readable C Code @ The Adafruit Learning System.

Code should be written to be readable and not just runnable.

Any code we write at Adafruit is ‘read’ by a many thousands of people with varying levels of experience with the software and hardware they are working with.

That puts a unique burden on us to produce code that doesn’t just ‘work’, but is also easy to understand and maintain.

In a conscious effort to improve our own code in this area, we’ve put together this simple guide to writing code that’s easier to read, maintain and understand.

While everything suggested here is somewhat personal, and largely a reflection of my own habits working in C over the years, as Adafruit continues to grow as a company we want to put more emphasis on code quality, in the same way we’ve focused on the quality of our HW designs and tutorials.

We’ve tried to keep these guidelines as general as possible recognizing that everyone has (and has the right to) their own style, but there are some things we think are worth insisting on in the interest of readability and keeping things accessible for customers.

Learn more.

Join 4,000+ makers on Adafruit’s Discord channels and be part of the community! http://adafru.it/discord

Learn “How Computers Work” with Bill Gates, Ladyada and more – From Code.org !

CircuitPython in 2018 – Python on Microcontrollers is here!

Have an amazing project to share? Join the SHOW-AND-TELL every Wednesday night at 7:30pm ET on Google+ Hangouts.

Join us every Wednesday night at 8pm ET for Ask an Engineer!

Follow Adafruit on Instagram for top secret new products, behinds the scenes and more https://www.instagram.com/adafruit/

Maker Business — Prototyping PCBs with Particle, a guide from a pro in the field #makerbusiness

Wearables — Learn about stretch

Electronics — Test for interference on the cheap!

Biohacking — Visualizing FLU Data with Wearables

Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at AdafruitDaily.com !

No Comments

No comments yet.

Sorry, the comment form is closed at this time.