Address feedback on unsafe-code/best-practices.md #48629
Draft
+64
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jkotas when you have a moment, could you please take a look at these changes? |
jkotas
reviewed
Sep 19, 2025
jkotas
reviewed
Sep 19, 2025
| @@ -947,7 +973,7 @@ While most of the suggestions in this document apply to interop scenarios as wel | |||
|
|
|||
| ## 23. Thread safety | |||
|
|
|||
| See [Managed threading best practices](../../standard/threading/managed-threading-best-practices.md) and [.NET Memory Model](https://github.com/dotnet/runtime/blob/main/docs/design/specs/Memory-model.md). | |||
| Although memory safety and thread safety are orthogonal concepts, many of the highlighed issues in this document can lead to thread safety issues as well. For example, non-atomic coalesced writes. See [Managed threading best practices](../../standard/threading/managed-threading-best-practices.md) and [.NET Memory Model](https://github.com/dotnet/runtime/blob/main/docs/design/specs/Memory-model.md). | |||
There was a problem hiding this comment.
many of the highlighed issues in this document
What are the bullet points that this is referring to?
There was a problem hiding this comment.
I was referring to
- Memory access coalescing
- Unaligned memory access
I don't have a strong opinion on this
There was a problem hiding this comment.
I would either omit it; or make it more concrete. As written, it raises more questions than answers.
jkotas
reviewed
Sep 19, 2025
Co-authored-by: Jan Kotas <[email protected]>
Co-authored-by: Jan Kotas <[email protected]>
jkotas
reviewed
Sep 20, 2025
| @@ -961,6 +987,24 @@ In the context of the unsafe code it's important to keep in mind: | |||
|
|
|||
| Fuzz testing (or "fuzzing") is an automated software testing technique that involves providing invalid, unexpected, or random data as inputs to a computer program. It provides a way to detect memory safety issues in code that may have gaps in test coverage. You can use tools like [SharpFuzz](https://github.com/Metalnem/sharpfuzz) to set up fuzz testing for .NET code. | |||
|
|
|||
| ## 26. Compiler warnings | |||
|
|
|||
| Generally, Roslyn intentionally doesn't provide extensive support such as warnings and analyzers around incorrect unsafe code usage. However, there are some existing warnings that can help detect potential issues and should not be ignored or suppressed without careful consideration. Some examples include: | |||
There was a problem hiding this comment.
Suggested change
| Generally, Roslyn intentionally doesn't provide extensive support such as warnings and analyzers around incorrect unsafe code usage. However, there are some existing warnings that can help detect potential issues and should not be ignored or suppressed without careful consideration. Some examples include: | |
| Generally, C# compiler doesn't provide extensive support such as warnings and analyzers around incorrect unsafe code usage. However, there are some existing warnings that can help detect potential issues and should not be ignored or suppressed without careful consideration. Some examples include: |
| @@ -947,7 +973,7 @@ While most of the suggestions in this document apply to interop scenarios as wel | |||
|
|
|||
| ## 23. Thread safety | |||
|
|
|||
| See [Managed threading best practices](../../standard/threading/managed-threading-best-practices.md) and [.NET Memory Model](https://github.com/dotnet/runtime/blob/main/docs/design/specs/Memory-model.md). | |||
| Although memory safety and thread safety are orthogonal concepts, many of the highlighed issues in this document can lead to thread safety issues as well. For example, non-atomic coalesced writes. See [Managed threading best practices](../../standard/threading/managed-threading-best-practices.md) and [.NET Memory Model](https://github.com/dotnet/runtime/blob/main/docs/design/specs/Memory-model.md). | |||
There was a problem hiding this comment.
I would either omit it; or make it more concrete. As written, it raises more questions than answers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses community feedback on #48557 article + some cleanup
26. Compiler warningsInternal previews