phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-25 02:33:24 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Link in developer notes style to internal interface exception

Browse source
This commit is contained in:
Jon Atack 2022-05-06 18:29:18 +02:00
parent fc4cb857cc
commit 5fca70f5b1
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/developer-notes.md
View file

@ -96,7 +96,10 @@ code.
Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Renum-caps), Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Renum-caps),
which recommend using `snake_case`. Please use what seems appropriate. which recommend using `snake_case`. Please use what seems appropriate.
- Class names, function names, and method names are UpperCamelCase - Class names, function names, and method names are UpperCamelCase
(PascalCase). Do not prefix class names with `C`. (PascalCase). Do not prefix class names with `C`. See [Internal interface
naming style](#internal-interface-naming-style) for an exception to this
convention.
- Test suite naming convention: The Boost test suite in file - Test suite naming convention: The Boost test suite in file
`src/test/foo_tests.cpp` should be named `foo_tests`. Test suite names `src/test/foo_tests.cpp` should be named `foo_tests`. Test suite names
must be unique. must be unique.
@ -1416,6 +1419,8 @@ communication:
virtual bool disconnect(NodeId id) = 0; virtual bool disconnect(NodeId id) = 0;
``` ```
### Internal interface naming style
- For consistency and friendliness to code generation tools, interface method - For consistency and friendliness to code generation tools, interface method
names should be `lowerCamelCase` and standalone function names should be names should be `lowerCamelCase` and standalone function names should be
`UpperCamelCase`. `UpperCamelCase`.