MicroCODE's JavaScript Style Guide.
This Javascript (.JS) Style Guide used by all coders involved in a MicroCODE project. This defines our documentation rules, code style rules, and code ordering rules.
- This Style Guide was started from the MIT xPRO Style Guide.
- The MIT xPRO Style Guide was created from the AirBnb JavaScript Style Guide.
- We have taken those guides and applied our experience from 30 years to make it our own.
- This is just a PDF to read, but be sure to use it in conjunction with our JavaScript Code Templates.
mcodeTemplate.html
componentTemplate.js
moduleTemplate.js
classTemplate.js
If there is anyting you do not understand about using this guide (along with our templates) get with other team members. Do NOT make assumptions about it use.
| Word or Acronym | Description/Definition |
|---|---|
| Template | A file used to start others to ensure code and documentation consistency. |
| ES5, ES6 | Different revisions of the JavaScript (ECMAScript) language standard. |
| JavaScriptSG | MicroCODE's JavaScript Style Guide. (Available on GitHub). |
Contributors names and contact info
- Timothy J McGuire @TimothyMcGuire
- 0.7 - Added JSDocs information
- 0.6 - Added notes about FIRA Font
- 0.5 - Added notes about A.I. assisting with consistent code
- 0.4 - Fat Arrow Functions
- 0.3 - Corrections and explanations
- 0.2 - Example pictures of code
- 0.1 - Monospaced Font examples and recommendations, CAESAR 'Hail Caesar!' statements.
- 0.0 - Initial Release
This project is licensed under the MIT License - see the LICENSE.md file for details
Inspiration, code snippets, etc.