Changeset View
Changeset View
Standalone View
Standalone View
doc/developer-notes.md
Show First 20 Lines • Show All 502 Lines • ▼ Show 20 Lines | |||||
Source code organization | Source code organization | ||||
-------------------------- | -------------------------- | ||||
- Implementation code should go into the `.cpp` file and not the `.h`, unless necessary due to template usage or | - Implementation code should go into the `.cpp` file and not the `.h`, unless necessary due to template usage or | ||||
when performance due to inlining is critical | when performance due to inlining is critical | ||||
- *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time | - *Rationale*: Shorter and simpler header files are easier to read, and reduce compile time | ||||
- Use only the lowercase alphanumerics (`a-z0-9`), underscore (`_`) and hyphen (`-`) in source code filenames. | |||||
- *Rationale*: `grep`:ing and auto-completing filenames is easier when using a consistent | |||||
naming pattern. Potential problems when building on case-insensitive filesystems are | |||||
avoided when using only lowercase characters in source code filenames. | |||||
- Don't import anything into the global namespace (`using namespace ...`). Use | - Don't import anything into the global namespace (`using namespace ...`). Use | ||||
fully specified types such as `std::string`. | fully specified types such as `std::string`. | ||||
- *Rationale*: Avoids symbol conflicts | - *Rationale*: Avoids symbol conflicts | ||||
Header Inclusions | Header Inclusions | ||||
----------------- | ----------------- | ||||
▲ Show 20 Lines • Show All 228 Lines • Show Last 20 Lines |