Add "Remarks" and "Example" headings for warning references in range [C4831, C4940]

Rageking8 · web-flow · commit 14e0b60dc29b · 2025-09-03T22:40:46.000+08:00
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-c4867.md b/docs/error-messages/compiler-warnings/compiler-warning-c4867.md
@@ -10,6 +10,8 @@ ms.assetid: 8a257d70-c3a7-462d-b285-e57c952a8bf7
 
 > 'function': function call missing argument list; use 'call' to create a pointer to member
 
+## Remarks
+
 A pointer to member function was initialized incorrectly.
 
 This warning can be generated as a result of compiler conformance work that was done for Visual Studio 2005: enhanced pointer-to-member conformance.  Code that compiled prior to Visual Studio 2005 will now generate C4867.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-c4868.md b/docs/error-messages/compiler-warnings/compiler-warning-c4868.md
@@ -10,6 +10,8 @@ ms.assetid: fc6aa7e5-34dd-4ec2-88bd-16e430361dc7
 
 > '_file_(*line_number*)' compiler may not enforce left-to-right evaluation order in braced initializer list
 
+## Remarks
+
 The elements of a braced initializer list are to be evaluated in left-to-right order. There are two cases in which the compiler is unable to guarantee this order: the first is when some of the elements are objects passed by value; the second is  when compiling with `/clr` and some of the elements are fields of objects or are array elements. When the compiler can't guarantee left-to-right evaluation it emits warning C4868.
 
 This warning can be generated as a result of compiler conformance work that was done for Visual Studio 2015 Update 2. Code that compiled prior to Visual Studio 2015 Update 2 can now generate C4868.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4835.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4835.md
@@ -10,6 +10,8 @@ ms.assetid: d2e44c62-7b0e-4a45-943d-97903e27ed9d
 
 > 'variable' : the initializer for exported data will not be run until managed code is first executed in the host assembly
 
+## Remarks
+
 When accessing data between managed components, it is recommended that you not use native C++ import and export mechanisms. Instead, declare your data members inside a managed type and reference the metadata with `#using` in the client. For more information, see [#using Directive](../../preprocessor/hash-using-directive-cpp.md).
 
 ## Examples
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4838.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4838.md
@@ -10,12 +10,16 @@ ms.assetid: fea07924-5feb-4ed4-99b5-1a8c41d28db6
 
 > conversion from 'type_1' to 'type_2' requires a narrowing conversion
 
+## Remarks
+
 An implicit narrowing conversion was found when using aggregate or list initialization.
 
 The C language allows implicit narrowing conversions in assignments and initialization, and C++ follows suit, even though unexpected narrowing is a cause of many code errors. To make code safer, the C++ standard requires a diagnostic message when a narrowing conversion occurs in an initialization list. In Visual C++, the diagnostic is [Compiler Error C2397](../../error-messages/compiler-errors-1/compiler-error-c2397.md) when using the uniform initialization syntax supported beginning in Visual Studio 2015. The compiler generates  warning C4838 when using the list or aggregate initialization syntax supported by Visual Studio 2013.
 
 A narrowing conversion can be okay when you know the possible range of converted values can fit in the target. In this case, you know more than the compiler does. If you make a narrowing conversion intentionally, make your intentions explicit by using a static cast. Otherwise, this warning message almost always indicates that you have a bug in your code. You can fix it by making sure the objects you initialize have types that are large enough to handle the inputs.
 
+## Example
+
 The following sample generates C4838 and shows one way to fix it:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4900.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4900.md
@@ -10,4 +10,6 @@ ms.assetid: 826997ec-0803-4794-ad35-bb463f679658
 
 > intermediate language mismatch between 'tool1' version 'version1' and 'tool2' version 'version2'
 
+## Remarks
+
 The intermediate language used in *tool1* and *tool2* did not match. Check that the most current version of each tool has been installed.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4905.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4905.md
@@ -10,6 +10,8 @@ ms.assetid: 40240bf4-b14e-4c22-aeb2-52f2851532f6
 
 > wide string literal cast to 'LPSTR'
 
+## Remarks
+
 The compiler detected an unsafe cast. The cast did succeed, but you should use a conversion routine.
 
 This warning is off by default. See [Compiler Warnings That Are Off by Default](../../preprocessor/compiler-warnings-that-are-off-by-default.md) for more information.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4906.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4906.md
@@ -10,6 +10,8 @@ ms.assetid: 05318e74-799b-412a-9dce-f02b8161d762
 
 > string literal cast to 'LPWSTR'
 
+## Remarks
+
 The compiler detected an unsafe cast. The cast did succeed, but you should use a conversion routine.
 
 This warning is off by default. See [Compiler Warnings That Are Off by Default](../../preprocessor/compiler-warnings-that-are-off-by-default.md) for more information.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4910.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4910.md
@@ -10,6 +10,8 @@ ms.assetid: 67963560-fbca-4ca7-93db-06beaf7055f0
 
 > '\<identifier>' : '__declspec(dllexport)' and 'extern' are incompatible on an explicit instantiation
 
+## Remarks
+
 The explicit template instantiation named *\<identifier>* is modified by both the `__declspec(dllexport)` and **`extern`** keywords. However, these keywords are mutually exclusive. The `__declspec(dllexport)` keyword means instantiate the template class, while the **`extern`** keyword means do not automatically instantiate the template class.
 
 ## See also
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4912.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4912.md
@@ -10,8 +10,12 @@ ms.assetid: ba1f1a66-8c20-4792-9ac8-43e49f729ae2
 
 > 'attribute': attribute has undefined behavior on a nested UDT
 
+## Remarks
+
 Attributes that apply to nested UDTs (user-defined type, which could be a typedef, union, or struct) may be ignored.
 
+## Example
+
 The following code shows how this warning would be generated:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4917.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4917.md
@@ -10,6 +10,8 @@ ms.assetid: c05e2610-4a5d-4f4b-a99b-c15fd7f1d5f1
 
 > 'declarator' : a GUID can only be associated with a class, interface or namespace
 
+## Remarks
+
 A user-defined structure other than [class](../../cpp/class-cpp.md), [interface](../../cpp/interface.md), or [namespace](../../cpp/namespaces-cpp.md) cannot have a GUID.
 
 This warning is off by default. See [Compiler Warnings That Are Off by Default](../../preprocessor/compiler-warnings-that-are-off-by-default.md) for more information.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4920.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4920.md
@@ -10,8 +10,12 @@ ms.assetid: 1e501f2e-93c1-4d27-a4fa-54fc86271ae7
 
 > enum enum member member=value already seen in enum enum as member=value
 
+## Remarks
+
 If a .tlb that you pass to #import has the same symbol defined in two or more enums, this warning indicates that subsequent identical symbols are ignored and will be commented out in the .tlh file.
 
+## Example
+
 Assuming a .tlb that contains:
 
 ```
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4925.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4925.md
@@ -10,10 +10,14 @@ ms.assetid: a4b206c0-016a-4f28-873a-bb8bb41bad50
 
 > 'method': dispinterface method cannot be called from script
 
+## Remarks
+
 Scripting languages cannot create a VT_BYREF 'in' parameter, it can only create VT_BYREF 'out' parameters.
 
 Another way to resolve this warning is not make the parameter (in the definition and implementation) a pointer type.
 
+## Example
+
 The following sample generates C4925:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4926.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4926.md
@@ -10,8 +10,12 @@ ms.assetid: 5717fce0-146f-4ef2-bde0-e9a01c0922d1
 
 > 'identifier': symbol is already defined: attributes ignored
 
+## Remarks
+
 A forward declaration was found but an attributed construct with the same name already exists. The attributes for the forward declaration are ignored.
 
+## Example
+
 The following sample generates C4926:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4927.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4927.md
@@ -10,8 +10,12 @@ ms.assetid: 7009e740-a2ef-4130-96ba-482e092f717a
 
 > illegal conversion; more than one user-defined conversion has been implicitly applied
 
+## Remarks
+
 More than one user-defined conversion is implicitly applied to a single value -- the compiler did not find an explicit conversion but did find a conversion, which it used.
 
+## Example
+
 The following sample generates C4927:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4928.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4928.md
@@ -10,10 +10,14 @@ ms.assetid: 77235d7f-9360-45cb-8348-d148c605c4a3
 
 > illegal copy-initialization; more than one user-defined conversion has been implicitly applied
 
+## Remarks
+
 More than one user-defined conversion routine was found. The compiler executed the code in all such routines.
 
 This warning is off by default. See [Compiler Warnings That Are Off by Default](../../preprocessor/compiler-warnings-that-are-off-by-default.md) for more information.
 
+## Example
+
 The following sample generates C4928:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4929.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4929.md
@@ -10,9 +10,11 @@ ms.assetid: 95f8ab4f-4468-4caa-acd5-8f4592f03b3c
 
 > 'file': typelibrary contains a union; ignoring the 'embedded_idl' qualifier
 
+## Remarks
+
 The embedded_idl attribute of [#import](../../preprocessor/hash-import-directive-cpp.md) could not be applied to the type library because a union is present in the type library. To resolve this warning, don't use embedded_idl.
 
-## Examples
+## Example
 
 The following sample defines a component.
 
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4930.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4930.md
@@ -10,8 +10,12 @@ ms.assetid: 89a206c9-c536-4186-8e81-1cde3e7f4f5b
 
 > 'prototype': prototyped function not called (was a variable definition intended?)
 
+## Remarks
+
 The compiler detected an unused function prototype. If the prototype was intended as a variable declaration, remove the open/close parentheses.
 
+## Examples
+
 The following sample generates C4930:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4935.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4935.md
@@ -10,6 +10,8 @@ ms.assetid: a36c56d3-571a-44dd-bb0f-bcc6b020e134
 
 > assembly access specifier modified from 'access'
 
+## Remarks
+
 The assembly visibility of a type was modified. The compiler uses the last specifier that it encounters. For example, the assembly visibility of a forward declaration may be different from the assembly visibility of the class definition.
 
 C4935 is only reachable using the obsolete compiler option **/clr:oldSyntax**.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4939.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4939.md
@@ -10,6 +10,8 @@ ms.assetid: 07096008-ba47-436c-a84c-2b03ad90d0b3
 
 > #pragma vtordisp is deprecated and will be removed in a future release of Visual C++
 
+## Remarks
+
 The [vtordisp](../../preprocessor/vtordisp.md) pragma will be removed in a future release of Visual C++.
 
 ## Example
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4839.md b/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4839.md
@@ -10,6 +10,8 @@ ms.assetid: f4f99066-9258-4330-81a8-f4a75a1d95ee
 
 > non-standard use of class '*type*' as an argument to a variadic function
 
+## Remarks
+
 Classes or structs that are passed to a variadic function such as `printf` must be trivially copyable. When passing such objects, the compiler simply makes a bitwise copy and does not call the constructor or destructor.
 
 This warning is available beginning in Visual Studio 2017.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4913.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4913.md
@@ -10,8 +10,12 @@ ms.assetid: b94aa52e-6029-4170-9134-017714931546
 
 > user defined binary operator ',' exists but no overload could convert all operands, default built-in binary operator ',' used
 
+## Remarks
+
 A call to the built-in comma operator occurred in a program that also had an overloaded comma operator; a conversion that you thought may have occurred did not.
 
+## Example
+
 The following code sample generates C4913:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4918.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4918.md
@@ -10,8 +10,12 @@ ms.assetid: 1bcf6d35-3467-4aa8-b2ef-cb33f4e70238
 
 > 'character' : invalid character in pragma optimization list
 
+## Remarks
+
 An unknown character was found in the optimization list of an [optimize](../../preprocessor/optimize.md) pragma statement.
 
+## Example
+
 For example, the following statement generates C4918:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4931.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4931.md
@@ -10,6 +10,8 @@ ms.assetid: cfbf08c7-94e4-4a91-a691-479d1dbe527a
 
 > we are assuming the type library was built for *number*-bit pointers
 
+## Remarks
+
 Explicit information was not supplied with the **ptrsize** attribute of the [#import](../../preprocessor/hash-import-directive-cpp.md) directive; the compiler concluded that pointer size of the type library is *number*.
 
 This warning is off by default. See [Compiler Warnings That Are Off by Default](../../preprocessor/compiler-warnings-that-are-off-by-default.md) for more information.
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4932.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4932.md
@@ -10,8 +10,12 @@ ms.assetid: 0b8d88cc-21f6-45cb-a9f5-1795b7db0dfa
 
 > `__identifier(identifier_1)` and `__identifier(identifier_2)` are indistinguishable
 
+## Remarks
+
 The compiler is unable to distinguish between **`_finally`** and **`__finally`** or **`__try`** and **`_try`** as a parameter passed to [`__identifier`](../../extensions/identifier-cpp-cli.md). You should not attempt to use them both as identifiers in the same program, as it will result in a [C2374](../../error-messages/compiler-errors-1/compiler-error-c2374.md) error.
 
+## Example
+
 The following sample generates C4932:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4937.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4937.md
@@ -10,10 +10,14 @@ ms.assetid: 2bb9f0e7-bbd6-4697-84de-95955e32ae29
 
 > 'text1' and 'text2' are indistinguishable as arguments to 'directive'
 
+## Remarks
+
 Because of the way the compiler processes arguments to directives, names that have meaning to the compiler, such as keywords with multiple text representations (single and double underscore forms), cannot be distinguished.
 
 Examples of such strings are __cdecl and \__forceinline.  Note, under /Za, only the double underscore forms are enabled.
 
+## Example
+
 The following sample generates C4937:
 
 ```cpp
diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4938.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4938.md
@@ -10,8 +10,12 @@ ms.assetid: 6acac81a-9d23-465e-b700-ed4b6e8edcd0
 
 > 'var' : Floating point reduction variable may cause inconsistent results under /fp:strict or #pragma fenv_access
 
+## Remarks
+
 You should not use [/fp:strict](../../build/reference/fp-specify-floating-point-behavior.md) or [fenv_access](../../preprocessor/fenv-access.md) with OpenMP floating-point reductions, because the sum is computed in a different order. Thus, results can differ from the results without /openmp.
 
+## Example
+
 The following sample generates C4938:
 
 ```cpp
