... | @@ -4,6 +4,15 @@ This document governs how your code should **look** rather than how it should ** |
... | @@ -4,6 +4,15 @@ This document governs how your code should **look** rather than how it should ** |
|
|
|
|
|
The starting point for CFML style is the [Ortus Solutions Coding Standards](https://github.com/Ortus-Solutions/coding-standards), but not every "rule" is as important as every other rule, and not all of them are enforced. We'll try to break down the most important areas where we we either agree and feel that it's very important, or else where we do things differently.
|
|
The starting point for CFML style is the [Ortus Solutions Coding Standards](https://github.com/Ortus-Solutions/coding-standards), but not every "rule" is as important as every other rule, and not all of them are enforced. We'll try to break down the most important areas where we we either agree and feel that it's very important, or else where we do things differently.
|
|
|
|
|
|
|
|
## CFML/Back-end Style Guides
|
|
|
|
|
|
|
|
* CFFormat: When editing a file that has not previously been CFFormatted, save and commit it immediately prior to making any other changes so that the CFFormat commit will be separate from your changes.
|
|
|
|
* Most CF style considerations are resolved by CFFormat, but some are not:
|
|
|
|
|
|
|
|
1. Semicolons: Lucee does not require them, but we do. Use semicolons to terminate statements.
|
|
|
|
2. Components should have a docblock section at the top indicating the original author, the date, and a brief description of the component.
|
|
|
|
3. Functions should have a docblock depending on where they live: API functions should have CBSwagger docblocks while model and service layer function docblocks only need to be human-readable (but should still designate @param and @return values).
|
|
|
|
|
|
## Front-end Style Guides
|
|
## Front-end Style Guides
|
|
|
|
|
|
* [VueJS (v2) Style Guide](https://vuejs.org/v2/style-guide/)
|
|
* [VueJS (v2) Style Guide](https://vuejs.org/v2/style-guide/)
|
... | | ... | |