|
|
@@ -1,13 +1,13 @@
|
|
|
# Stride diagnostics
|
|
|
|
|
|
-Stride.Core.CompilerServices contains Roslyn code analyzers.
|
|
|
+`Stride.Core.CompilerServices` contains Roslyn code analyzers.
|
|
|
|
|
|
> [!IMPORTANT]
|
|
|
> Analyzers are offline tools used by the compiler to assist programmers. They are not used to collect telemetry on how Stride is being used. These same analyzers are also utilized by your IDE to generate CSXXXX diagnostics.
|
|
|
|
|
|
-They analyze the code for possible issues in your project with the Stride.Core design.
|
|
|
+They analyze the code for possible issues in your project with the `Stride.Core` design.
|
|
|
To avoid unexpected runtime/compile time/editor time behaviour these analyzers try to warn as soon as possible for issues that may occur.
|
|
|
-Each of the following pages contain information about diagnostic codes that can be reported by the Roslyn analyzers, which are built into Stride.Core.CompilerServices.
|
|
|
+Each of the following pages contain information about diagnostic codes that can be reported by the Roslyn analyzers, which are built into `Stride.Core.CompilerServices`.
|
|
|
|
|
|
The information covers:
|
|
|
|
|
|
@@ -16,10 +16,9 @@ The information covers:
|
|
|
- Examples when such a diagnostics occurs
|
|
|
- Information about how to resolve the diagnostic
|
|
|
|
|
|
-If an error is reported it is possible to click in the IDE on the `diagnostic code` in the information box about the diagnostic.
|
|
|
-This will open the corresponding information page about the diagnostic.
|
|
|
+If an error is reported it is possible to click in the IDE on the `diagnostic code` in the information box about the diagnostic. This will open the corresponding information page about the diagnostic.
|
|
|
|
|
|
-The Stride.Core.CompilerServices is linked to Stride.Core, the diagnostic Analysis will only occur if your project references Stride.Core in the PackageReferences, this will automatically add the Stride.Core.CompilerServices to your project.
|
|
|
+The `Stride.Core.CompilerServices` is linked to `Stride.Core`, the diagnostic Analysis will only occur if your project references `Stride.Core` in the PackageReferences, this will automatically add the `Stride.Core.CompilerServices` to your project.
|
|
|
|
|
|
> [!WARNING]
|
|
|
> Note that diagnostic feature is experimental and may not work as expected. Warnings may contain solutions that don't work yet.
|
Vaclav Elias