Skip to content

Commit ba1c3e2

Browse files
committed
Merge pull request #1636 from sharwell/docs-cleanup
Minor documentation cleanup
2 parents 019ade5 + 9ef0fbb commit ba1c3e2

2 files changed

Lines changed: 14 additions & 21 deletions

File tree

documentation/Configuration.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,6 @@ Code analysis rule sets are the standard way to configure most diagnostic analyz
1818

1919
The easiest way to add a **stylecop.json** configuration file to a new project is using a code fix provided by the project. To invoke the code fix, open any file where SA1633 is reported¹ and press Ctrl+. to bring up the Quick Fix menu. From the menu, select **Add StyleCop settings file to the project**.
2020

21-
> :warning: At this time, the code fix is not able to fully configure the newly-created **stylecop.json** file for use. This is tracked in bug report [dotnet/roslyn#4655](https://github.com/dotnet/roslyn/issues/4655). In the mean time, users must manually perform the following additional steps after creating the **stylecop.json** file.
22-
>
23-
> 1. Right click the project in **Solution Explorer** and select **Unload Project**. If you are asked to save changes, click **Yes**.
24-
> 2. Right click the unloaded project in **Solution Explorer** and select **Edit *ProjectName*.csproj**.
25-
> 3. Locate the following item in the project file.
26-
27-
> ```csharp
28-
> <None Include="stylecop.json" />
29-
> ```
30-
31-
> 4. Change the definition to the following.
32-
33-
> ```csharp
34-
> <AdditionalFiles Include="stylecop.json" />
35-
> ```
36-
37-
> 5. Save and close the project file.
38-
> 6. Right click the unloaded project in **Solution Explorer** and select **Reload Project**.
39-
4021
### JSON Schema for IntelliSense
4122

4223
A JSON schema is available for **stylecop.json**. By including a reference in **stylecop.json** to this schema, Visual Studio will offer IntelliSense functionality (code completion, quick info, etc.) while editing this file. The schema may be configured by adding the following top-level property in **stylecop.json**:

documentation/SA1652.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,20 @@ errors over time.
3434
To fix a violation of this rule, enable the XML documentation file as part of the project output.
3535

3636
**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573 and/or CS1591
37-
to be reported. To improve the ability of teams to resolve SA1652 before CS1573 and/or CS1591, consider editing the
38-
project file to include the following property group.
37+
to be reported. To improve the ability of teams to resolve SA1652 before CS1573 and/or CS1591, consider disabling these
38+
warnings by one of the following methods.
39+
40+
### Suppression via rule set files
41+
42+
CS1573 and CS1591 are most easily suppressed by editing the rule set file. The severity of these rules may be set to
43+
**Hidden** or **None** to hide them from the build output.
44+
45+
### Suppression via the project file
46+
47+
For users who sometimes build their project with older versions of C# (which do not support rule set files), these
48+
warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both the
49+
documentation output (which corrects SA1652) and the suppressions for CS1573 and CS1591 is to add the following property
50+
group to the project file.
3951

4052
```xml
4153
<PropertyGroup>

0 commit comments

Comments
 (0)