Annotate API reference types for nullable awareness #176
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.
Description
Introduced with C# 8.0, we can annotate the code to specify if a reference-type variable can be null or not. Then, we can enable a new static analysis check that check for potential code paths that will de-reference a null pointer, throwing a
NullReferenceException
.Annotating the API allows user to enable the feature as well and ensure a safe usage of the code. Fix all the related warnings
This is introducing the following breaking changes:
TextDataReader
will not returnnull
string if it starts reading from the end already. It will throwEndOfStreamException
.Po
initializes an empty header.PoHeader
are initialized to an empty string instead of null values,CreationDate
is set to current time.Po.Header
will not check if the header has some required non-empty properties.Po2Binary
will write the PO header only ifProjectIdVersion
is non-empty instead of checking if theHeader
property is null.Example
To enable the feature in any user project, just set
<Nullable>enable</Nullable>
in the csproj.