system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-21 10:05:32 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Documentation: Recommend using clangd for code formatting in VSCode

Browse source 
Turns out clangd supports code formatting using the clang-format
engine. Because we also document another code formatter to install,
when users use both extensions VSCode will ask to choose one or the
other. Therefore, let's just choose clangd for code formatting since
it is needed anyways for code comprehension.
This commit is contained in:
Kemal Zebari 2024-02-23 10:57:31 -08:00 committed by Andrew Kaster
parent fff49ab6d3
commit 7fbc8bf719
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Documentation/VSCodeConfiguration.md
View file

@ -7,7 +7,6 @@ The WSL Remote extension allows you to use VS Code in Windows while using the no
The recommended extensions for VS Code include:
- [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd)
- [clang-format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
- [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
## Code comprehension
@ -119,7 +118,7 @@ following ``c_cpp_properties.json`` to circumvent some errors. Even with the con
## Formatting
The [clang-format extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) works out of the box. ``clang-format`` support is also included with the Microsoft C/C++ tools (see above). The settings below include a key that makes the Microsoft extension use the proper style.
clangd provides code formatting out of the box using the ``clang-format`` engine. ``clang-format`` support is also included with the Microsoft C/C++ tools (see above). The settings below include a key that makes the Microsoft extension use the proper style.
## Settings