Skip to content
FSAC AST Docs

VSCode ROS 开发指南 (Clang)

在 VSCode 中的 “C/C++” 插件（此插件默认与 ROS 官方插件搭配）在开发 ROS（C++）上实在显得力不从心。你可能会遇到以下情况：

  • 糟糕的头文件索引（CMakeList 写明了各种库，而你还需要在 cpp_configuration 中添加路径来为 C/C++ 插件提供索引。

  • 由于没有良好的索引，静态代码检查完全无法工作

  • 完全没有用的 “quick-fix” 只能傻傻的提示一下可能的错误

所以为了提升自己开发 C++ 的体验和节约开发时间，更加推荐使用 clang + clangd 配合 VSC 插件进行开发。

安装 clang/clangd “后端”

以 ubuntu 18.04 作为示例，安装可分为以下几步。

  1. 安装 clang

    这步并不麻烦，打开终端输入：

    Terminal window
    sudo apt install clang
    # 考虑到 ubuntu 源更新，其名称可能变为：clang-10

  2. 安装 clangd

    由于 ubuntu 默认的软件源貌似没有提供 clangd 的最新二进制包，只能退而求其次安装 clangd 10。（截至写作时 clangd 的最新版本是 clangd 16）

    Terminal window
    sudo apt install clangd-10 （也有 clangd-9 可选）

    VSCode 所使用的 “clangd” 插件默认寻找 “clangd” 可执行文件，而刚刚安装的是 clang-10。
    这会导致 “clangd” 插件尝试去 llvm 官网下载最新二进制包，对于我们来说是不必要的。因此创建一个软链接将 clangd-10 导向 clangd 即可。

    Terminal window
    sudo ln -s /usr/bin/clangd-10 /usr/bin/clangd

  3. 安装 clang-format

    这步不是必选，但是安装这个后可以在 VSC 中使用 clang 的代码格式化。

    Terminal window
    sudo apt install clang-format

  4. 配置 clang-format

    同样地，这一步也是可选的。 在项目根目录下添加 .clang-format 文件，并修改为以下内容。

    Language:        Cpp
    

    # BasedOnStyle:  Google
    

    AccessModifierOffset: -1
    AlignAfterOpenBracket: Align
    AlignConsecutiveAssignments: false
    AlignConsecutiveDeclarations: false
    AlignEscapedNewlines: Left
    AlignOperands:   true
    AlignTrailingComments: true
    AllowAllParametersOfDeclarationOnNextLine: true
    AllowShortBlocksOnASingleLine: false
    AllowShortCaseLabelsOnASingleLine: false
    AllowShortFunctionsOnASingleLine: All
    AllowShortIfStatementsOnASingleLine: true
    AllowShortLoopsOnASingleLine: true
    AlwaysBreakAfterDefinitionReturnType: None
    AlwaysBreakAfterReturnType: None
    AlwaysBreakBeforeMultilineStrings: true
    AlwaysBreakTemplateDeclarations: true
    BinPackArguments: true
    BinPackParameters: true
    BraceWrapping:
    AfterClass:      true
    AfterControlStatement: true
    AfterEnum:       true
    AfterFunction:   true
    AfterNamespace:  false
    AfterObjCDeclaration: false
    AfterStruct:     true
    AfterUnion:      true
    AfterExternBlock: true
    BeforeCatch:     true
    BeforeElse:      true
    IndentBraces:    false
    SplitEmptyFunction: true
    SplitEmptyRecord: true
    SplitEmptyNamespace: true
    BreakBeforeBinaryOperators: None
    BreakBeforeBraces: Custom
    BreakBeforeInheritanceComma: false
    BreakBeforeTernaryOperators: true
    BreakConstructorInitializersBeforeComma: false
    BreakConstructorInitializers: BeforeColon
    BreakAfterJavaFieldAnnotations: false
    BreakStringLiterals: true
    ColumnLimit:     80
    CommentPragmas:  '^ IWYU pragma:'
    CompactNamespaces: false
    ConstructorInitializerAllOnOneLineOrOnePerLine: true
    ConstructorInitializerIndentWidth: 4
    ContinuationIndentWidth: 4
    Cpp11BracedListStyle: true
    DerivePointerAlignment: true
    DisableFormat:   false
    ExperimentalAutoDetectBinPacking: false
    FixNamespaceComments: true
    ForEachMacros:
    

    - foreach
    - Q_FOREACH
    - BOOST_FOREACH
    IncludeBlocks:   Preserve
    IncludeCategories:
    - Regex:           '^<ext/.*\.h>'
        Priority:        2
    - Regex:           '^<.*\.h>'
        Priority:        1
    - Regex:           '^<.*'
        Priority:        2
    - Regex:           '.*'
        Priority:        3
    IncludeIsMainRegex: '([-_](test|unittest))?$'
    IndentCaseLabels: true
    IndentPPDirectives: None
    IndentWidth:     4
    IndentWrappedFunctionNames: false
    JavaScriptQuotes: Leave
    JavaScriptWrapImports: true
    KeepEmptyLinesAtTheStartOfBlocks: false
    MacroBlockBegin: ''
    MacroBlockEnd:   ''
    MaxEmptyLinesToKeep: 1
    NamespaceIndentation: None
    ObjCBlockIndentWidth: 2
    ObjCSpaceAfterProperty: false
    ObjCSpaceBeforeProtocolList: false
    PenaltyBreakAssignment: 2
    PenaltyBreakBeforeFirstCallParameter: 1
    PenaltyBreakComment: 300
    PenaltyBreakFirstLessLess: 120
    PenaltyBreakString: 1000
    PenaltyExcessCharacter: 1000000
    PenaltyReturnTypeOnItsOwnLine: 200
    PointerAlignment: Right
    RawStringFormats:
    - Delimiter:       pb
        Language:        TextProto
        BasedOnStyle:    google
    ReflowComments:  true
    SortIncludes:    true
    SortUsingDeclarations: true
    SpaceAfterCStyleCast: false
    SpaceAfterTemplateKeyword: true
    SpaceBeforeAssignmentOperators: true
    SpaceBeforeParens: ControlStatements
    SpaceInEmptyParentheses: false
    SpacesBeforeTrailingComments: 1
    SpacesInAngles:  false
    SpacesInContainerLiterals: false
    SpacesInCStyleCastParentheses: false
    SpacesInParentheses: false
    SpacesInSquareBrackets: false
    Standard:        Auto
    TabWidth:        4
    UseTab:          Never

    这是一份基于 Goolgle 代码规范的格式化标准，做了有关括号位置和缩进大小的自定义修改。你可以在这里查阅到关于 clang-format 的所有设置选项。

安装 VSCode 插件

安装以下插件，括号里面的是作者名称，不要下载到错误的插件。

  • clangd (LLVM)

  • 【可选】Clang-Format (Xaver Hellauer)

  • CMake (twxs)

ext

clangd 设置

在 VSCode 插件中找到 clangd 插件的设置，在“Clangd: Arguments” 中添加：--compile-commands-dir=${workspaceFolder}/build

此配置将会指明编译后文件的存放路径。

clangd-setting

在工作空间下执行：catkin config --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON，来设置空间的编译参数。

接着使用 catkin build 编译一下。

如果使用 “catkin_make” 则可以在每次使用时加上 “-DCMAKE_EXPORT_COMPILE_COMMANDS=1”即：catkin_make -DCMAKE_EXPORT_COMPILE_COMMANDS=1 来直接在 build/ 下生成 compile_commands.json

若 build/ 目录下没有 compile_commands.json 文件，而分散在各包名目录下，则可以使用这里的 shell 脚本来合并。 此操作在依赖不变的情况下，仅需进行一次。

结语

这样就可以愉快的使用 clangd 的特性进行 ROS 开发了。

参考链接

【1】https://blog.csdn.net/weixin_43862847/article/details/119274382
【2】https://zhuanlan.zhihu.com/p/514541589
【3】https://blog.csdn.net/m0_38144614/article/details/116986927
【4】https://github.com/catkin/catkin_tools/issues/551