XiHan.Framework.Kernel.Analyzers 5.0.0-preview.2

Prefix Reserved
This is a prerelease version of XiHan.Framework.Kernel.Analyzers.
dotnet add package XiHan.Framework.Kernel.Analyzers --version 5.0.0-preview.2
                    
NuGet\Install-Package XiHan.Framework.Kernel.Analyzers -Version 5.0.0-preview.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XiHan.Framework.Kernel.Analyzers" Version="5.0.0-preview.2">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="XiHan.Framework.Kernel.Analyzers" Version="5.0.0-preview.2" />
                    
Directory.Packages.props
<PackageReference Include="XiHan.Framework.Kernel.Analyzers">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add XiHan.Framework.Kernel.Analyzers --version 5.0.0-preview.2
                    
#r "nuget: XiHan.Framework.Kernel.Analyzers, 5.0.0-preview.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package XiHan.Framework.Kernel.Analyzers@5.0.0-preview.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=XiHan.Framework.Kernel.Analyzers&version=5.0.0-preview.2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=XiHan.Framework.Kernel.Analyzers&version=5.0.0-preview.2&prerelease
                    
Install as a Cake Tool

XiHan.Framework.Kernel.Analyzers

关于

XiHan.Framework.Kernel.Analyzers 是 Roslyn 分析器:把公开 API 的稳定性标注、类型命名与零反射规则交给编译器执行。写框架扩展包的人可以在自己的项目里启用同一套规则;应用引用它即可在编译期挡住对内部 API 的使用。

主要特性

  • XH0001:公开类型必须标注 [ApiLevel]
  • XH0002 / XH0004:公开类型名不得以 XiHan 开头,不得使用 Manager、Helper、Default 等禁用词
  • XH0003:不得在程序集之外使用标注为 Stability.Internal 的 API
  • XH0005:原语层与内核不得使用反射 API

如何使用

安装

dotnet add package XiHan.Framework.Kernel.Analyzers --prerelease

使用

引用后 XH0003 对所有引用者生效;命名与零反射规则由 MSBuild 属性开启(包里已把它们声明为编译器可见):

<PropertyGroup>
  <XiHanFrameworkPackage>true</XiHanFrameworkPackage>   
  <XiHanRing>1</XiHanRing>                              
</PropertyGroup>

触发示例(缺少稳定性标注,报 XH0001):

public sealed class ReportExporter;   // XH0001

分析器是开发依赖,不进入运行时。

主要类型

此库提供的主要类型:

  • PublicTypeAnalyzer:XH0001、XH0002、XH0004
  • InternalApiUsageAnalyzer:XH0003
  • ReflectionUsageAnalyzer:XH0005

更多文档

相关包

反馈与贡献

XiHan.Framework.Kernel.Analyzers 以 MIT 许可证 开源。欢迎到 GitHub 仓库 提交问题和贡献。

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
5.0.0-preview.2 0 11/6/2026
5.0.0-preview.1 36 11/4/2026