diff options
author | Russell Yanofsky <russ@yanofsky.org> | 2020-04-08 15:08:35 -0400 |
---|---|---|
committer | Russell Yanofsky <russ@yanofsky.org> | 2020-04-08 15:08:35 -0400 |
commit | 05f9770c1fa64bd9730cd6e18ec333e0801c00d6 (patch) | |
tree | 9dde78ebb5420c03b90cf297979576ce674245ed /doc/release-notes/release-notes-0.6.1.md | |
parent | b3c3d9a518f8cc51c0b73c5e4ee6bd567be441d2 (diff) |
doc: Clarify developer notes about constant naming
I'm pretty sure developer notes were intended to say constants should be upper
case and variables should be lower case, but right now they are ambiguous about
whether to write:
```c++
// foo.h
extern const int SYMBOL;
// foo.cpp
const int SYMBOL = 1;
```
or:
```c++
// foo.h
extern const int g_symbol;
// foo.cpp
const int g_symbol = 1;
```
First convention above is better than the second convention because it tells
you without having to look anything up that the value of `SYMBOL` will never
change at runtime. Also I've never seen any c++ project anywhere using the
second convention
Diffstat (limited to 'doc/release-notes/release-notes-0.6.1.md')
0 files changed, 0 insertions, 0 deletions