marrub
/
zscript-doc
mirror of https://github.com/marrub--/zscript-doc
1
0
Fork 0
Code Releases Activity

style guide

pull/1/head
an 2019-08-14 06:35:49 -04:00
parent 62f0107abc
commit 8081cd640b
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
glossary/Style.md
View File

@ -169,8 +169,8 @@ members, and so this prefix is omitted within them.
## Layout Conventions ## Layout Conventions
Use 3 spaces for indentation. Indent at each block, but do not indent `case` Use tabs with a width of 3 characters for indentation. Indent at each block,
labels. Align all code to 80 columns. but do not indent `case` labels. Align all code to 80 columns.
Write only one statement or declaration per line, except in the case of Write only one statement or declaration per line, except in the case of
multiple-assignment operations, in which case pairing all of the related multiple-assignment operations, in which case pairing all of the related
@ -193,9 +193,10 @@ when there is a single sub-statement, for instance with `if(x) y = z;`.
The convention of 3 spaces for indentation comes from [Eternity Engine's style The convention of 3 spaces for indentation comes from [Eternity Engine's style
guideline.][1] There is no other reason for this decision, other than it is guideline.][1] There is no other reason for this decision, other than it is
pleasing to the eye while not being excessive. The indentation and blank line pleasing to the eye while not being excessive. Hardware tabs are used instead
rules are generally the same as the majority of C-like language style of spaces in order to allow for user configuration, increasing accessibility.
guidelines. The indentation and blank line rules are generally the same as the majority of
C-like language style guidelines.
Alignment to 80 columns is for the purpose of reading the raw documentation Alignment to 80 columns is for the purpose of reading the raw documentation
text under standard size Linux terminals. This is useful, for instance, when text under standard size Linux terminals. This is useful, for instance, when