mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 10:35:50 +00:00
755849115e
Fixes: RIPD-1521 Switch to pure doxygen HTML for developer docs. Remove docca/boostbook system. Convert consensus document to markdown. Add existing markdown files to doxygen input set. Fix some image paths and scale images for use with MD links. Rename/cleanup some files for consistency. Add pipeline logic for windows slaves. Add ninja and parallel test run option. Add make doc target build in build-and-test.sh. Cleanup README files. Add nounity windows build. Add link to jenkins summary table. Add rippled_classic build (win). Improve formatting of summary table.
21 lines
686 B
Markdown
21 lines
686 B
Markdown
# Code Style Cheat Sheet
|
|
|
|
## Form
|
|
|
|
- One class per header file.
|
|
- Place each data member on its own line.
|
|
- Place each ctor-initializer on its own line.
|
|
- Create typedefs for primitive types to describe them.
|
|
- Return descriptive local variables instead of constants.
|
|
- Use long descriptive names instead of abbreviations.
|
|
- Use "explicit" for single-argument ctors
|
|
- Avoid globals especially objects with static storage duration
|
|
- Order class declarations as types, public, protected, private, then data.
|
|
- Prefer 'private' over 'protected'
|
|
|
|
## Function
|
|
|
|
- Minimize external dependencies
|
|
* Pass options in the ctor instead of using theConfig
|
|
* Use as few other classes as possible
|