Proposed prerelease attributes to signify members/types that are prerelease
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
PRI.PrereleaseAttributes.Analyzer
PRI.PrereleaseAttributes
Tests
.editorconfig
.gitattributes
.gitignore
CodeCoverage.runsettings
LICENSE
PrereleaseAttributes.sln
PrereleaseAttributes.sln.DotSettings
README.md
appveyor.yml
caution.png

README.md

PrereleaseAttributes

Build status NuGet Coverage Status

Proposed prerelease attributes to signify members/types that are prerelease.

PrereleaseAttributes has 4 attriutes: PrereleaseAttribute, ExperimentalAttribute, AlphaAttribute, and PreviewAttribute. The idea is that someone writing code or providing a library to someone else could add one of these attributes to signify the code is one or more of instable, unsupported, or untested.

The idea is that an IDE/Analyzer could detect that attribute and warn/error that a code base was using experimental features.

Usage

Pretty straightforward:

[Experimental]
public class MyExperiment
{
    // omitted
}

Ideally, but optionally, you can include detail about why:

[Experimental("I just wrote this one day, only 33% code coverage.")]
public class MyExperiment
{
    // omitted
}

Icons made by Freepik from www.flatiron.com is licensed by CC 3.0 BY