Skip to content

Commit

Permalink
doc: Clarify developer notes about constant naming
Browse files Browse the repository at this point in the history
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
  • Loading branch information
ryanofsky committed Apr 8, 2020
1 parent b3c3d9a commit 05f9770
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/developer-notes.md
Expand Up @@ -83,7 +83,7 @@ code.
separate words (snake_case).
- Class member variables have a `m_` prefix.
- Global variables have a `g_` prefix.
- Compile-time constant names are all uppercase, and use `_` to separate words.
- Constant names are all uppercase, and use `_` to separate words.
- Class names, function names, and method names are UpperCamelCase
(PascalCase). Do not prefix class names with `C`.
- Test suite naming convention: The Boost test suite in file
Expand Down

0 comments on commit 05f9770

Please sign in to comment.