speeduino
/
wiki.js
mirror of https://github.com/speeduino/wiki.js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update dev/Style_code

This commit is contained in:
Administrator 2020-01-06 04:58:34 +00:00 committed by Josh Stewart
parent 0e2d7bf950
commit cf871ff830
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
dev/Style_code.md
View File

@ -2,16 +2,17 @@
title: Style Guide
description: Style guidelines used within the Speeduino firmware
published: true
date: 2020-01-06T04:57:38.671Z
date: 2020-01-06T04:58:33.942Z
tags:
---
# Goal
The Speeduino firmware aspires to a common, unified approach to code layout based on the guidelines on this page. Any pull requests or submissions should align with these recommendations as much as possible.
# MISRA
## A note on MISRA compliance
Speeduino strives for compliance to the MISRA C:2012 coding standard and many of the conventions below are to align with this. A full description of the requirments of MISRA C:2012 is beyond the scope of this document, but the code does include a MISRA scanning script based on cppcheck that you can use to verify your code changes.
# Details
## File Structure
Within code files (`.ino`), items must be arranged in the following sequence: