Add "Remarks" headings for warning references in range [C6401, C6999]

Rageking8 · web-flow · commit 028ba9aeb6ed · 2025-09-07T23:00:36.000+08:00
diff --git a/docs/code-quality/c6500.md b/docs/code-quality/c6500.md
@@ -10,11 +10,11 @@ ms.assetid: bfc61ec1-8ac5-4465-a23c-91418fbc4552
 
 > Invalid annotation: value for '*name*' property is invalid
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that a property value used in the annotation isn't valid. For example, it can occur if an incorrect level of dereference is used in the `Deref` property, or if you use a constant value that is larger than `size_t` for properties like `ElementSize`.
 
 Code analysis name: `INVALID_ATTRIBUTE_PROPERTY`
diff --git a/docs/code-quality/c6501.md b/docs/code-quality/c6501.md
@@ -10,11 +10,11 @@ ms.assetid: f9e8b847-2516-4bbb-bb1c-c87cfbacf254
 
 > Annotation conflict: '*name*' property conflicts with previously specified property
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates the presence of conflicting properties in the annotation. The warning typically occurs when multiple properties that serve similar purpose are used to annotate a parameter or return value. To correct the warning, you must choose the property that best addresses your need.
 
 Code analysis name: `CONFLICTING_ATTRIBUTE_PROPERTY_VALUES`
diff --git a/docs/code-quality/c6503.md b/docs/code-quality/c6503.md
@@ -10,11 +10,11 @@ ms.assetid: a6212938-bef9-4830-becb-6baa70b53e97
 
 > Invalid annotation: references and arrays may not be marked `Null=Yes` or `Null=Maybe`
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that `Null` property is incorrectly used on a reference or array type. A reference or array type holds the address of an object and must point to a valid object. Because reference and array types can't be null, you must correct the error by either removing the `Null` property or by setting the `Null` property value to `No`.
 
 Code analysis name: `REFERENCES_CANT_BE_NULL`
diff --git a/docs/code-quality/c6504.md b/docs/code-quality/c6504.md
@@ -9,10 +9,10 @@ helpviewer_keywords: ["C6504"]
 
 > Invalid annotation: property may only be used on values of pointer, pointer-to-member, or array type
 
-This warning indicates the use of a pointer-specific SAL annotation on a non-pointer data type.
-
 ## Remarks
 
+This warning indicates the use of a pointer-specific SAL annotation on a non-pointer data type.
+
 For more information about what data types are supported by properties, see [Annotation Properties](using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
 Code analysis name: `NULL_ON_NON_POINTER`
diff --git a/docs/code-quality/c6508.md b/docs/code-quality/c6508.md
@@ -10,11 +10,11 @@ ms.assetid: ac5b23c8-ab9e-481b-bc97-8404f0b63100
 
 > Invalid annotation: write access is not allowed on const values
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that the Access property specified on a const parameter implies that it can be written to. For constant values, Access=Read is the only valid setting.
 
 Code analysis name: `WRITE_ACCESS_ON_CONST`
diff --git a/docs/code-quality/c6511.md b/docs/code-quality/c6511.md
@@ -10,11 +10,11 @@ ms.assetid: 1a0ac213-c205-4fb1-9bc3-3dc7885329fa
 
 > Invalid annotation: MustCheck property must be Yes or No
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates an invalid value for `MustCheck` property was specified. The only valid values for this property are: Yes and No.
 
 Code analysis name: `MUSTCHECK_MAYBE`
diff --git a/docs/code-quality/c6513.md b/docs/code-quality/c6513.md
@@ -10,11 +10,11 @@ ms.assetid: b27780ac-b237-4b26-a796-68a920da73a3
 
 > Invalid annotation: ElementSizeConst requires additional size properties
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that `ElementSizeConst` requires other properties that are missing from the annotation. Specifying `ElementSizeConst` alone doesn't provide any benefit to the analysis process. In addition to specifying `ElementSize`, other properties such as `ValidElementsConst` or `WritableElementsConst` must also be specified.
 
 Code analysis name: `ELEMENT_SIZE_WITHOUT_BUFFER_SIZE`
diff --git a/docs/code-quality/c6516.md b/docs/code-quality/c6516.md
@@ -10,11 +10,11 @@ ms.assetid: 461078c8-18d4-49ca-80a2-a15736f429a0
 
 > Invalid annotation: no properties specified for '*name*' attribute
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that either no property was specified in the attribute or the property that was specified is invalid; therefore, the attribute can't be considered complete.
 
 Code analysis name: `NO_PROPERTIES_ON_ATTRIBUTE`
diff --git a/docs/code-quality/c6517.md b/docs/code-quality/c6517.md
@@ -10,11 +10,11 @@ ms.assetid: 96822155-8b2a-4699-980f-744afff84ca8
 
 > Invalid annotation: 'SAL_readableTo' property may not be specified on buffers that are not readable: '*Parameter*'.
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that `SAL_readableTo` property doesn't have the required read access. You can't use this property to annotate a parameter without providing read access.
 
 Code analysis name: `VALID_SIZE_ON_NON_READABLE_BUFFER`
diff --git a/docs/code-quality/c6522.md b/docs/code-quality/c6522.md
@@ -10,11 +10,11 @@ ms.assetid: ac482f63-b27f-4807-968a-1c449033d2dd
 
 > Invalid size specification: expression must be of integral type: annotation '*annotation*' on function '*function*' '*parameter*'
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that an integral type was expected, but an incorrect data type was used. You can use annotation properties that accept the size of a parameter in terms of another parameter, but you must use correct data type. For a list of annotation properties, see [Using SAL Annotations to reduce code defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
 Code analysis name: `INVALID_SIZE_STRING_TYPE`
diff --git a/docs/code-quality/c6525.md b/docs/code-quality/c6525.md
@@ -10,11 +10,11 @@ ms.assetid: a7af4dc7-d5a4-455f-a414-0c389ffd9aa9
 
 > Invalid size specification: property value may not be valid
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that the property value used to specify the size isn't valid. The warning occurs if the size parameter is annotated using `Valid=No`.
 
 Code analysis name: `INVALID_SIZE_STRING_UNREACHABLE_LOCATION`
diff --git a/docs/code-quality/c6530.md b/docs/code-quality/c6530.md
@@ -10,11 +10,11 @@ ms.assetid: 60e9dc58-e0f1-4a34-8c75-efebaa6cadd2
 
 > Unrecognized format string style '*name*'
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
 
-## Remarks
-
 This warning indicates that the `FormatString` property is using a value other than `scanf` or `printf`. To correct this warning, review your code and use a valid value for the `Style` property.
 
 Code analysis name: `UNRECOGNIZED_FORMAT_STRING_STYLE`
diff --git a/docs/code-quality/c6551.md b/docs/code-quality/c6551.md
@@ -10,5 +10,7 @@ ms.assetid: cfd02698-7ba7-4564-841d-208999b1561d
 
 > Invalid size specification: expression not parsable
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
diff --git a/docs/code-quality/c6552.md b/docs/code-quality/c6552.md
@@ -10,5 +10,7 @@ ms.assetid: 6c6f17d8-4ddd-4fad-b81f-e32285e7afa8
 
 > Invalid `Deref=` or `Notref=`: expression not parsable
 
+## Remarks
+
 > [!NOTE]
 > This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
diff --git a/docs/code-quality/c6701.md b/docs/code-quality/c6701.md
@@ -9,4 +9,6 @@ helpviewer_keywords: ["C6701"]
 
 > The value is not a valid Yes/No/Maybe value: '*string*'
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6702.md b/docs/code-quality/c6702.md
@@ -10,4 +10,6 @@ ms.assetid: 6d373843-4ab4-4a94-bb83-5fec9214c625
 
 > The value is not a string value: '*string*'
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6703.md b/docs/code-quality/c6703.md
@@ -10,4 +10,6 @@ ms.assetid: 8ec4f403-e63e-4930-8266-569c9cd263b4
 
 > The value is not a number: '*string*'
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6704.md b/docs/code-quality/c6704.md
@@ -10,4 +10,6 @@ ms.assetid: fc25543d-746e-415e-b0a8-d5134461af41
 
 > Unexpected Annotation Expression Error: '*annotation*' ['*why*']
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6705.md b/docs/code-quality/c6705.md
@@ -10,4 +10,6 @@ ms.assetid: 5d81e7ac-0c51-4cca-aaa8-df1aa599f175
 
 > Annotation error expected <expected_number> arguments for annotation '*parameter*' found <actual_number>.
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6706.md b/docs/code-quality/c6706.md
@@ -10,4 +10,6 @@ ms.assetid: 20f3fd01-4993-4f7f-bd3f-57706356cf1d
 
 > Unexpected Annotation Error for annotation '*annotation*': '*why*'
 
+## Remarks
+
 This warning is reported when there's an error in the annotations.
diff --git a/docs/code-quality/c6993.md b/docs/code-quality/c6993.md
@@ -9,6 +9,8 @@ helpviewer_keywords: ["C6993"]
 
 > Code analysis ignores OpenMP constructs; analyzing single-threaded code
 
+## Remarks
+
 This warning indicates that the static analysis tools don't support Open MP pragmas. The static analysis tools could generate incorrect results because they assume the code is single-threaded, not multi-threaded.
 
 Your code doesn't necessarily need to be 'fixed' to resolve this diagnostic because this warning indicates what the toolset supports and not an issue with your code.
diff --git a/docs/code-quality/c6995.md b/docs/code-quality/c6995.md
@@ -9,6 +9,8 @@ helpviewer_keywords: ["C6995"]
 
 > Failed to save XML Log file
 
+## Remarks
+
 This warning indicates that the Code Analysis tool can't create the defect log, which is the output of the code analysis.
 
 This error might indicate a disk error or indicate that you don't have permission to create a file in the specified directory.
