f5ff579e93 | ||
---|---|---|
src | ||
tools | ||
.gitattributes | ||
.gitignore | ||
CONTRIBUTING.md | ||
EnlistmentInfo.props | ||
EnlistmentInfo.targets | ||
LICENSE | ||
README.md | ||
appveyor.yml | ||
init.cmd | ||
init.ps1 | ||
nuget.config | ||
version.json |
README.md
Microsoft.VisualStudio.Validation
This project is available as the Microsoft.VisualStudio.Validation NuGet package.
Basic input validation via the Requires
class throws an ArgumentException.
Requires.NotNull(arg1, nameof(arg1));
Requires.NotNullOrEmpty(arg2, nameof(arg2));
State validation via the Verify
class throws an InvalidOperationException.
Verify.Operation(condition, "some error occurred.");
Internal integrity checks via the Assumes
class throws an
InternalErrorException.
Assumes.True(condition, "some error");
Warning signs that should not throw exceptions via the Report
class.
Report.IfNot(condition, "some error");
Code Snippets
Make writing input validation especially convenient with code snippets.
Run the tools\install_snippets.cmd script within this package to copy the code snippets
into your Documents\Visual Studio 201x\Code Snippets\Visual C#\My Code Snippets
folder(s) and just type the first few letters of the code snippet name to get
auto-completion assisted input validation.
Note that if you have Resharper installed, code snippets don't appear in
auto-completion lists so you may have to press Ctrl+J
after the first few letters
of the code snippet name for it to become available.
Example:
private void SomeMethod(string input) {
rnne<TAB>
}
Expands to
private void SomeMethod(string input) {
Requires.NotNullOrEmpty(paramName, nameof(paramName));
}
And the first paramName
is selected. Simply type the actual parameter name
(Intellisense will auto-complete for you) and then the quoted paramName name
will automatically be changed to match.
The two snippets are rnn
and rnne
which expand to check for null inputs or null-or-empty inputs, respectively.