Skip to content

Commit 82385a1

Browse files
authored
Update README.md
1 parent 1854fd1 commit 82385a1

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,29 @@ Roslyn code analyzers
88
# Project Promo:
99

1010
![1](https://github.com/omsdotnet/ZorroCodeAnalyzers/blob/main/promo/640x320.png?raw=true)
11+
12+
13+
### Purpose of code analyzers
14+
15+
[Roslyn Code Analyzers](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/) - Roslyn compiler extension technology for C#/VB.NET languages, which provides the ability to describe your own rules for errors/warnings and your own code refactorings. Analyzers are supplied as nuget packages, when connected to a project, the compiler automatically picks up analyzers and refactorings and uses them when building. In addition, the Visual Studio development environment also takes into account the connected analyzers, showing messages from them as you work with the program text, and offers refactorings using pop-up bubbles, along with its own built-in refactorings.
16+
Code analyzers are useful for automating code reviews in terms of checking compliance with development standards, as well as for writing custom refactorings.
17+
18+
19+
### List of code analyzers
20+
21+
* *ZA0001* - Feature namespaces must not overlap
22+
* *ZA0002* - Domain namespaces must not overlap with Application and Infrastructure
23+
* *ZA0003* - Application namespaces must not overlap with Infrastructure
24+
* *ZA0004* - Infrastructure port and adapters must not overlap
25+
26+
27+
### Using code analyzers
28+
29+
Add a link to the ZorroCodeAnalyzers nuget-package to your project, to add a link to all projects in the solution, it is convenient to use the mechanism
30+
[Directory.Build.props](https://docs.microsoft.com/en-us/visualstudio/msbuild/customize-your-build?view=vs-2019#directorybuildprops-and-directorybuildtargets).
31+
32+
33+
### Repository contents
34+
35+
* Solution *src\ZorroCodeAnalyzers* - a solution with a code analyzers and refactorings contains tests and VisualStudio plugin (vsix)
36+
* Solution *src\ZorroCodeAnalyzers.Example* - a solution with a project that references the compiled package ```ZorroCodeAnalyzers``` contains various code examples with analyzer-specific errors and is used to check the correctness of code analyzers

0 commit comments

Comments
 (0)