In order to keep an easy-to-read, consistent and aesthetically pleasing look to the Trimble code, the following coding style guide is advised.
- Provides good rationale for decisions, including even counter-arguments
- Exceptions to the code style allowed to maintain local consistency in existing code
None. Exceptions that would benefit a specific project should be documented along with a rationale for the exception.
|Tools/Procedures||Type||In Use By||Notes|
|cpplint.py||Open Source||Tekla||Validates Google code style. It can be modified to account for any exceptions we add to the original standard.|
|SonarQube||Open Source and Commercial||Tekla||Continuous Inspection, centralization of quality, DevOps integration, detection of tricky issues.|
|clang-format||Free||Tekla||Formats source code according to style guide.|
|Peer reviews||SketchUp||Validates of code style, code quality.|
|Tekla||Structures||SonarQube as a style enforcer|
- Good documentation of what goes into setting up a Boost library project. Contains links to other documents and references to books.