Mirrors/cppbestpractices
1
0
Fork 0
mirror of https://github.com/cpp-best-practices/cppbestpractices.git synced 2025-12-17 03:04:36 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add notes on various analysis tools

Browse Source
This commit is contained in:
Jason Turner
2017-01-05 23:02:07 -07:00
committed by GitHub
parent d7bd72b7d4
commit 6445e67d83
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
02-Use_the_Tools_Available.md
View File

@@ -19,6 +19,7 @@ Use an industry standard widely accepted build tool. This prevents you from rein
* [CMake](http://www.cmake.org/) * [CMake](http://www.cmake.org/)
* Consider: https://github.com/sakra/cotire/ for build performance * Consider: https://github.com/sakra/cotire/ for build performance
* Consider: https://github.com/toeb/cmakepp for enhanced usability * Consider: https://github.com/toeb/cmakepp for enhanced usability
* Utilize: https://cmake.org/cmake/help/v3.6/command/target_compile_features.html for C++ standard flags
* [Conan](https://www.conan.io/) - a crossplatform dependency manager for C++ * [Conan](https://www.conan.io/) - a crossplatform dependency manager for C++
* [C++ Archive Network (CPPAN)](https://cppan.org/) - a crossplatform dependency manager for C++ * [C++ Archive Network (CPPAN)](https://cppan.org/) - a crossplatform dependency manager for C++
* [Waf](https://waf.io/) * [Waf](https://waf.io/)
@@ -138,6 +139,16 @@ Consider using the *treat warnings as errors* setting. `/Wx` with MSVC, `-Werror
## LLVM-based tools ## LLVM-based tools
LLVM based tools work best with a build system (such as cmake) that can output a compile command database, for example:
```
$ cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .
```
If you are not using a build system like that, you can consider [Build EAR](https://github.com/rizsotto/Bear) which will hook into your build system and generate a compile command database for you.
CMake now also comes with built-in support for calling `clang-tidy` during [normal compilation](https://cmake.org/cmake/help/latest/prop_tgt/LANG_CLANG_TIDY.html).
* [include-what-you-use](https://github.com/include-what-you-use), [example results](https://github.com/ChaiScript/ChaiScript/commit/c0bf6ee99dac14a19530179874f6c95255fde173) * [include-what-you-use](https://github.com/include-what-you-use), [example results](https://github.com/ChaiScript/ChaiScript/commit/c0bf6ee99dac14a19530179874f6c95255fde173)
* [clang-modernize](http://clang.llvm.org/extra/clang-modernize.html), [example results](https://github.com/ChaiScript/ChaiScript/commit/6eab8ddfe154a4ebbe956a5165b390ee700fae1b) * [clang-modernize](http://clang.llvm.org/extra/clang-modernize.html), [example results](https://github.com/ChaiScript/ChaiScript/commit/6eab8ddfe154a4ebbe956a5165b390ee700fae1b)
* [clang-check](http://clang.llvm.org/docs/ClangCheck.html) * [clang-check](http://clang.llvm.org/docs/ClangCheck.html)
@@ -277,7 +288,7 @@ Don't forget to make sure that your error handling is being tested and works pro
### ClangFormat ### ClangFormat
[ClangFormat](http://clang.llvm.org/docs/ClangFormat.html) can check and correct code formatting to match organizational conventions automatically. [ClangFormat](http://clang.llvm.org/docs/ClangFormat.html) can check and correct code formatting to match organizational conventions automatically. [Multipart series](https://engineering.mongodb.com/post/succeeding-with-clangformat-part-1-pitfalls-and-planning/) on utilizing clang-format.
### SourceMeter ### SourceMeter