|
@@ -1,9 +1,30 @@
|
|
|
# Stride diagnostics
|
|
# Stride diagnostics
|
|
|
|
|
|
|
|
-Some C# compiler errors have corresponding topics that explain why the error is generated, and, in some cases, how to fix the error. Use one of the following steps to see whether help is available for a particular error message.
|
|
|
|
|
|
|
+Stride.Core.CompilerServices contains Roslyn code analyzers.
|
|
|
|
|
|
|
|
-[Rule of Thumb Serialization](../manual/scripts/serialization.md#rule-of-thumb)
|
|
|
|
|
|
|
+> [!IMPORTANT]
|
|
|
|
|
+> These analyzers do not perform any kind of telemetry. The same analyzers get used by your IDE when you get a CSXXXX diagnostic.
|
|
|
|
|
+
|
|
|
|
|
+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.
|
|
|
|
|
+
|
|
|
|
|
+The information covers:
|
|
|
|
|
+
|
|
|
|
|
+- When is the diagnostics reported
|
|
|
|
|
+- An explanation why it is necessary to report the diagnostic
|
|
|
|
|
+- 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.
|
|
|
|
|
+
|
|
|
|
|
+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]
|
|
> [!WARNING]
|
|
|
-> Please note that this diagnostic feature is experimental and may not work as expected.
|
|
|
|
|
-> Warnings might include solutions that are not yet fully functional.
|
|
|
|
|
|
|
+> Note that diagnostic feature is experimental and may not work as expected. Warnings may contain solutions that don't work yet.
|
|
|
|
|
+
|
|
|
|
|
+## References
|
|
|
|
|
+
|
|
|
|
|
+- [Rule of Thumb Serialization](../manual/scripts/serialization.md#rule-of-thumb)
|
|
|
|
|
+- [Serialisation](../manual/scripts/serialization.md)
|
Vaclav Elias