Repository navigation
docs: explain using CA1062 with guard clauses - #420
Merged
Merged
Conversation
|
ardalis
approved these changes
Nov 17, 2026
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
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.



Closes #165
Adds a README section on using CA1062 to find public methods that don't guard their parameters, as suggested in the issue.
It turns out no
null_check_validation_methodsconfiguration is needed.Null,NullOrEmpty,NullOrWhiteSpaceandNotFoundalready mark their input with[ValidatedNotNull], and CA1062 honours that attribute. Enabling the rule is enough.I checked this with Ardalis.GuardClauses 5.0.0 on net8.0 and
dotnet_diagnostic.CA1062.severity = warning:Guard.Against.Null(order); order.NameGuard.Against.NullOrEmpty(s); s.Trim()order.Namewith no guard<Nullable>enable</Nullable>[ValidatedNotNull]The last two rows are why the section suggests
[ValidatedNotNull]for custom guards in a shared library.