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.
Adafruit publishes a wide range of writing and video content, including interviews and reporting on the maker market and the wider technology world. Our standards page is intended as a guide to best practices that Adafruit uses, as well as an outline of the ethical standards Adafruit aspires to. While Adafruit is not an independent journalistic institution, Adafruit strives to be a fair, informative, and positive voice within the community – check it out here: adafruit.com/editorialstandards
Adafruit is on Mastodon, join in! adafruit.com/mastodon
Stop breadboarding and soldering – start making immediately! Adafruit’s Circuit Playground is jam-packed with LEDs, sensors, buttons, alligator clip pads and more. Build projects with Circuit Playground in a few minutes with the drag-and-drop MakeCode programming site, learn computer science using the CS Discoveries class on code.org, jump into CircuitPython to learn Python and hardware together, TinyGO, or even use the Arduino IDE. Circuit Playground Express is the newest and best Circuit Playground board, with support for CircuitPython, MakeCode, and Arduino. It has a powerful processor, 10 NeoPixels, mini speaker, InfraRed receive and transmit, two buttons, a switch, 14 alligator clip pads, and lots of sensors: capacitive touch, IR proximity, temperature, light, motion and sound. A whole wide world of electronics and coding is waiting for you, and it fits in the palm of your hand.
Have an amazing project to share? The Electronics Show and Tell is every Wednesday at 7:30pm ET! To join, head over to YouTube and check out the show’s live chat and our Discord!
Join us every Wednesday night at 8pm ET for Ask an Engineer!
Join over 38,000+ makers on Adafruit’s Discord channels and be part of the community! http://adafru.it/discord
CircuitPython – The easiest way to program microcontrollers – CircuitPython.org
New Products – Adafruit Industries – Makers, hackers, artists, designers and engineers! — NEW PRODUCT – Adafruit Sunken USB Type C Breakout Board
Python for Microcontrollers – Adafruit Daily — Python on Microcontrollers Newsletter: New CircuitPython Versions, Books Galore and So Much More! #CircuitPython #Python #micropython @ThePSF @Raspberry_Pi
EYE on NPI – Adafruit Daily — EYE on NPI Maxim’s Himalaya uSLIC Step-Down Power Module #EyeOnNPI @maximintegrated @digikey
Adafruit IoT Monthly — IoT Vulnerability Disclosure, Decorative Dorm Lights, and more!
Maker Business – Adafruit Daily — A look at Boeing’s supply chain and manufacturing process
Electronics – Adafruit Daily — When do I use X1?
Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at
AdafruitDaily.com !
No comments yet.
Sorry, the comment form is closed at this time.
