Skip to content

Commit b021207

Browse files
authored
Merge pull request stride3d#171 from IXLLEGACYIXL/master
update index.md Thank you @IXLLEGACYIXL
2 parents 384262a + cb11e2f commit b021207

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

Diff for: en/diagnostics/index.md

+25-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,30 @@
11
# Stride diagnostics
22

3-
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.
3+
Stride.Core.CompilerServices contains Roslyn code analyzers.
44

5-
[Rule of Thumb Serialization](../manual/scripts/serialization.md#rule-of-thumb)
5+
> [!IMPORTANT]
6+
> These analyzers do not perform any kind of telemetry. The same analyzers get used by your IDE when you get a CSXXXX diagnostic.
7+
8+
They analyze the code for possible issues in your project with the Stride.Core design.
9+
To avoid unexpected runtime/compile time/editor time behaviour these analyzers try to warn as soon as possible for issues that may occur.
10+
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.
11+
12+
The information covers:
13+
14+
- When is the diagnostics reported
15+
- An explanation why it is necessary to report the diagnostic
16+
- Examples when such a diagnostics occurs
17+
- Information about how to resolve the diagnostic
18+
19+
If an error is reported it is possible to click in the IDE on the `diagnostic code` in the information box about the diagnostic.
20+
This will open the corresponding information page about the diagnostic.
21+
22+
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.
623

724
> [!WARNING]
8-
> Please note that this diagnostic feature is experimental and may not work as expected.
9-
> Warnings might include solutions that are not yet fully functional.
25+
> Note that diagnostic feature is experimental and may not work as expected. Warnings may contain solutions that don't work yet.
26+
27+
## References
28+
29+
- [Rule of Thumb Serialization](../manual/scripts/serialization.md#rule-of-thumb)
30+
- [Serialisation](../manual/scripts/serialization.md)

0 commit comments

Comments
 (0)