diff --git a/docs/core/whats-new/dotnet-9/libraries.md b/docs/core/whats-new/dotnet-9/libraries.md index aeb42b7cee2dd..0356d756fabc9 100644 --- a/docs/core/whats-new/dotnet-9/libraries.md +++ b/docs/core/whats-new/dotnet-9/libraries.md @@ -757,7 +757,7 @@ The following codes shows some of the APIs included with the new `Tensor` typ :::code language="csharp" source="../snippets/dotnet-9/csharp/Tensors.cs" id="Tensor"::: > [!NOTE] -> This API is marked as [experimental](../../../fundamentals/apicompat/preview-apis.md#experimentalattribute) for .NET 9. +> This API is marked as [experimental](../../../fundamentals/syslib-diagnostics/experimental-overview.md) for .NET 9. ### TensorPrimitives diff --git a/docs/fundamentals/apicompat/preview-apis.md b/docs/fundamentals/apicompat/preview-apis.md index 6fbfc5ee8be89..42fad69e6ca33 100644 --- a/docs/fundamentals/apicompat/preview-apis.md +++ b/docs/fundamentals/apicompat/preview-apis.md @@ -54,6 +54,8 @@ When building against an experimental API, the compiler will produce an error. E Since each experimental feature has a separate ID, consenting to using one experimental feature doesn't consent to using another. +For more information, see [Experimental features][experimental-overview]. + ## Choose between the options Library developers should only use prerelease NuGet packages or mark APIs with `[Experimental]`: @@ -67,3 +69,4 @@ The `[RequiresPreviewFeatures]` attribute is only meant for components of the .N The exception to this rule is if you're building a stable library and want to expose certain features that in turn depend on runtime or language preview behaviors. In that case you should use `[RequiresPreviewFeatures]` for the entry points of that feature. However, you need to consider that users of such APIs have to turn on preview features too, which exposes them to all runtime, library, and language preview behaviors. [choosing-diagnostic-ids]: ../../csharp/roslyn-sdk/choosing-diagnostic-ids.md +[experimental-overview]: ../syslib-diagnostics/experimental-overview.md diff --git a/docs/fundamentals/syslib-diagnostics/experimental-overview.md b/docs/fundamentals/syslib-diagnostics/experimental-overview.md new file mode 100644 index 0000000000000..f180077ce23e9 --- /dev/null +++ b/docs/fundamentals/syslib-diagnostics/experimental-overview.md @@ -0,0 +1,64 @@ +--- +title: Experimental features in .NET 9+ +titleSuffix: "" +description: Learn about APIs that are marked as experimental in .NET 9 and later versions that produce SYSLIB compiler warnings. +ms.date: 10/21/2024 +--- + +# Experimental features in .NET 9+ + +Starting in .NET 9, some features make use of the to indicate that the API shape or functionality is included in the release but not yet officially supported. Experimental features let the .NET team collect feedback on an API's shape and functionality with the intent of refining the API and removing the `[Experimental]` attribute in the next major release. + +When your code references an experimental API, the compiler produces an error with an ID like `SYSLIB5XXX`. Each feature that's marked as experimental has a unique diagnostic ID. To express consent to using an experimental feature, you suppress the specific diagnostic. You can do that via any of the means for suppressing diagnostics, but the recommended way is to add the diagnostic to the project's `` property. For more information, see [Suppress warnings](#suppress-warnings). + +Since each experimental feature has a separate ID, consenting to using one experimental feature doesn't consent to using another. + +## Reference + +The following table provides an index to the `SYSLIB5XXX` experimental APIs in .NET 9+. + +| Diagnostic ID | Experimental version | Description | +| - | - | - | +| SYSLIB5001 | .NET 9 | and related APIs in are experimental | +| SYSLIB5002 | .NET 9 | alternate colors are experimental | +| SYSLIB5003 | .NET 9 | is experimental | +| SYSLIB5004 | .NET 9 | is experimental since performance is not as optimized as `T.DivRem` | +| SYSLIB5005 | .NET 9 | is experimental | + +## Suppress warnings + +Using an experimental feature gives you the opportunity to submit feedback on the API shape and functionality before the feature is marked as stable and fully supported. But using the feature produces a warning from the compiler. When you suppress the warning, you acknowledge that the API shape or functionality might change in the next major release. The API might even be removed. You can suppress the warning through a `` project setting (recommended) or a `#pragma` directive in code. + +To suppress the warnings in a project file: + +```xml + + + net9.0 + + $(NoWarn);SYSLIB5001 + + $(NoWarn);SYSLIB5002 + $(NoWarn);SYSLIB5003 + + $(NoWarn);SYSLIB5001;SYSLIB5002;SYSLIB5003 + + +``` + +To suppress the warnings in code: + +```csharp +// Disable the warning. +#pragma warning disable SYSLIB5001 + +// Code that uses an experimental API that produces the diagnostic SYSLIB5001 +//... + +// Re-enable the warning. +#pragma warning restore SYSLIB5001 +``` + +## See also + +- [Preview APIs](../apicompat/preview-apis.md) diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index 5e2bd415760b8..8a82233ea88e4 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -1800,6 +1800,11 @@ items: href: ../../fundamentals/syslib-diagnostics/syslib0056.md - name: SYSLIB0057 href: ../../fundamentals/syslib-diagnostics/syslib0057.md + - name: Experimental features + items: + - name: Overview + displayName: syslib, experimental + href: ../../fundamentals/syslib-diagnostics/experimental-overview.md - name: Source-generated code items: - name: Overview