Skip to content

Commit 56ec8fb

Browse files
Merge pull request #6222 from TylerMSFT/include
doc new syntax
2 parents 0a85ea4 + f68f380 commit 56ec8fb

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/ide/include-cleanup-config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Configure C/C++ Include Cleanup in Visual Studio"
33
description: "Learn how to configure C/C++ Include Cleanup."
4-
ms.date: 10/10/2023
4+
ms.date: 01/23/2026
55
ms.topic: "how-to"
66
f1_keywords: ["config include cleanup"]
77
helpviewer_keywords: ["config include cleanup"]
@@ -59,7 +59,7 @@ The `.editorconfig` settings that you can use with Include Cleanup are:
5959
| `cpp_include_cleanup_excluded_files`</br></br>Excludes the specified files from Include Cleanup messages. You won't get a suggestion related to the header at all, whether to add it or that it's unused. | *filename* | `cpp_include_cleanup_excluded_files = vcruntime.h, vcruntime_string.h` |
6060
| `cpp_include_cleanup_required_files`</br></br>Specify that usage of *file1* requires *file2*. For example, specify that if you use `atlwin.h` that `altbase.h` must also be included. | *file1*:*file2* | `cpp_include_cleanup_required_files = atlwin.h:altbase.h, atlcom.h:altbase.h` |
6161
| `cpp_include_cleanup_replacement_files`</br></br>Replaces *file1* with *file2* during Include Cleanup processing. For example, you may prefer using `cstdio` over `stdio.h`. If you have a file with both `#include <cstdio>` and `#include <stdio.h>` and you consume content only from `stdio.h`, with this setting Include Cleanup will tell you to remove `stdio.h` because it replaced the usage of `cstdio` with `stdio.h` during processing. If you don't use the contents from either, Include Cleanup will tell you to remove both.| *file1*:*file2* | `cpp_include_cleanup_replacement_files = stdio.h:cstdio,stdint.h:cstdint` |
62-
| `cpp_include_cleanup_alternate_files`</br></br>Don't generate a message for indirect include *file2* if *file1* is included. For example, if you `#include <windows.h>` and are only using something from its indirectly included header `winerror.h`, Include Cleanup won't prompt to add `winerror.h`. Useful when you prefer to include a facade header file instead of the indirect includes it contains. | *file1*:*file2* | `cpp_include_cleanup_alternate_files = windows.h:winerror.h, windows.h:minwindef.h` |
62+
| `cpp_include_cleanup_alternate_files`</br></br>Suppress messages for indirect includes. For example, if you `#include <windows.h>` and only use content from its indirectly included headers `winerror.h` or `minwindef.h`, the tool won't suggest adding them. | *file1*:*file2*[:*file3*...][,*file4*:*file5*...] | `cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h`</br>or</br>`cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h,umbrella.h:internal.h`|
6363

6464
## See also
6565

0 commit comments

Comments
 (0)