Skip to content

Commit

Permalink
Merge bitcoin#18568: doc: Clarify developer notes about constant naming
Browse files Browse the repository at this point in the history
05f9770 doc: Clarify developer notes about constant naming (Russell Yanofsky)

Pull request description:

  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++
  extern const int SYMBOL;
  ```

  or:

  ```c++
  extern const int g_symbol;
  ```

  First convention above is better than the second convention because it tells you without having to look anything up that the value of `SYMBOL` won't change at runtime. Also I haven't seen other c++ projects using the second convention.

ACKs for top commit:
  MarcoFalke:
    cr ACK 05f9770
  practicalswift:
    ACK 05f9770
  jarolrod:
    ACK 05f9770 🥃

Tree-SHA512: 766d0e25d9db818d45df4ad6386987014f2053584cbced4b755ceef8bda6b7e2cfeb34eb8516423bd03b140faaf577614d5e3be2799f7eed0eb439187ab85323
  • Loading branch information
fanquake authored and PastaPastaPasta committed Dec 22, 2021
1 parent 296c8e0 commit c0cec9a
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 c0cec9a

Please sign in to comment.