mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

CODINGSTYLE.md: note that macros should be caps'd

Browse source 
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
This commit is contained in:
Quentin Young 2022-03-27 18:16:59 -04:00 • committed by Dirk Hohndel
parent 9745f80431
commit dbbb39e0f7
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CODINGSTYLE.md
View file

@ -103,6 +103,17 @@ other editors that implement this coding style, please add them here.
where the two meet, use your best judgment and go for best consistency where the two meet, use your best judgment and go for best consistency
(i.e., where does the name "originate") (i.e., where does the name "originate")
* macro names should be capitalized; e.g., prefer
```
#define FROB 17
#define FROBULATE(x) (x)+FROB
```
to
```
#define frob 17
#define frobulate(x) (x)+frob
```
* there is a strong preference for lower case file names; sometimes conventions * there is a strong preference for lower case file names; sometimes conventions
or outside requirements make camelCase filenames the better (or only) choice, or outside requirements make camelCase filenames the better (or only) choice,
but absent such an outside reason all file names should be lower case but absent such an outside reason all file names should be lower case