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 05:00:34 +00:00 committed by Josh Stewart
parent cf871ff830
commit 41706018bf
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
dev/Style_code.md
View File

@ -2,7 +2,7 @@
title: Style Guide
description: Style guidelines used within the Speeduino firmware
published: true
date: 2020-01-06T04:58:33.942Z
date: 2020-01-06T05:00:33.219Z
tags:
---
@ -42,10 +42,10 @@ All names should be meaningful and follow existing usage patterns if present.
## Naming Conventions
| Item | Standard | Example |
|---------------------------------------------|--------------------------------------------------------------|---------------------------|
| Functions | camelCase, lowercase first letter, no spaces or _ | readSensor(); |
| Variables | sensorValue = 0; |
| Anonymous variables (eg some loop counters) | Single lowercase letter (Preferred order or use: x, y, z, i) | x++; |
| Constants | UPPER_CASE, words joined with _ | 1. define TWO_SQUARED 4 |
| Functions | camelCase, lowercase first letter, no spaces or _ | `readSensor();` |
| Variables | Same as functions | `sensorValue = 0;` |
| Anonymous variables (eg some loop counters) | Single lowercase letter (Preferred order or use: x, y, z, i) | `x++;` |
| Constants | UPPER_CASE, words joined with _ | `#define TWO_SQUARED 4` |
## Layout and whitespace
- Use spaces for indents, not tabs