mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-12-17 04:58:04 +08:00
6482e9b0de
* Use XamlStyler to check XAML formatting * fix spellcheck * fix * format XAML FLS, Hosts, ImageResizer, MeasureTool, PowerRename * format XAML Peek * exclude settings XAML and make CI pass * doc
1.8 KiB
1.8 KiB
Coding Style
Philosophy
- If it's inserting something into the existing classes/functions, try to follow the existing style as closely as possible.
- If it's brand new code or refactoring a complete class or area of the code, please follow as Modern C++ of a style as you can and reference the C++ Core Guidelines as much as you possibly can.
Formatting
- We use XamlStyler to format XAML files. You can use the Visual Studio Extension or apply formatting executing
.\.pipelines\applyXamlStyling.ps1 -Main
. - We use
.clang-format
style file to enable automatic code formatting. You can easily format source files from Visual Studio. For example,CTRL+K CTRL+D
formats the current document. - If you prefer another text editor or have ClangFormat disabled in Visual Studio, you could invoke
format_sources
powershell script from command line. It gets a list of all currently modified files fromgit
and invokes clang-format on them. Please note that you should also haveclang-format.exe
in%PATH%
for it to work. The script can infer the path ofclang-format.exe
version which is shipped with Visual Studio at%VCINSTALLDIR%\Tools\Llvm\bin\
, if you launch it from the Native Tools Command Prompt for VS. - CI doesn't enforce code formatting yet, since we're gradually applying code formatting to the codebase, but please adhere to our formatting style for any new code.