Skip to content

Commit 9f828c6

Browse files
committed
docs: localization README.md
1 parent b35f1cf commit 9f828c6

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Cnblogs.CodeQuality
2+
English | [中文](https://github.com/cnblogs/code-quality/blob/main/README.zh-hans.md)
3+
24
A bunch of rulesets used by Cnblogs, including StyleCop (`SA-XXXX`) and some other rules (`CA-XXXX`, `IDE-XXXX`, `DOC-XXXX`).
35

46
## How to use

README.zh-hans.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Cnblogs.CodeQuality
2+
3+
[English](https://github.com/cnblogs/code-quality/blob/main/README.md) | 中文
4+
5+
博客园开源项目使用的 Roslyn 分析器规则集,包括 StyleCop (`SA-XXXX`) 及其他的一些规则 (`CA-XXXX`, `IDE-XXXX`, `DOC-XXXX`)。
6+
7+
## 如何使用
8+
9+
如果只需要对少数项目启用,直接在这些项目上安装 `Cnblogs.CodeQuality` 包即可。
10+
11+
如果希望对整个解决方案或者目录启用,在 `Directory.Build.props` 文件中添加如下代码。
12+
13+
```xml
14+
<ItemGroup>
15+
<PackageReference Include="Cnblogs.CodeQuality" Version="1.1.0">
16+
<PrivateAssets>all</PrivateAssets>
17+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
18+
</PackageReference>
19+
</ItemGroup>
20+
```
21+
22+
重新编译后应该就可以在输出中看到分析器给出的 Warning 和 Error 了。
23+
24+
如果你使用 Rider 或者 Visual Studio,IDE 还会给出这些问题的快速修复,VS 默认开启分析,Rider 可以通过下面的路径找到 Roslyn 分析器设置。
25+
26+
**Rider:** Editor -> Inspection Settings -> Roslyn Analyzers ([.NET Compiler Platform (Roslyn) Analyzers—JetBrains Rider](https://www.jetbrains.com/help/rider/Using_NET_Compiler_Analyzers.html))

0 commit comments

Comments
 (0)