ライブラリガイダンス

このガイドでは、高品質の .NET ライブラリを作成するための開発者向け推奨事項を説明します。このドキュメントでは、.NET ライブラリを構築するときの、"方法" ではなく、"内容" と "理由" について説明します。

高品質の .NET ライブラリの特徴:

包括的である - 多くのプラットフォーム、プログラミング言語、アプリケーションをサポートするように、適切な .NET ライブラリで対応しています。
安定している - 適切な .NET ライブラリが .NET エコシステム内で共存しており、多くのライブラリを使用してビルドされたアプリケーション内で実行されます。
進化するように設計されている - .NET ライブラリは、既存のユーザーをサポートしながら、時間の経過と共に改善され進化します。
デバッグできる - .NET ライブラリでは、最新のツールを使用してユーザー向けの優れたデバッグエクスペリエンスが作成されます。
信頼されている - .NET ライブラリは、セキュリティのベストプラクティスを使用して NuGet に発行することにより、開発者から信頼されています。

推奨事項の種類

各記事で 4 種類の推奨事項 (実施、検討、回避、実施しない) が提示されます。推奨事項の種類によって、その推奨設定にどの程度厳密に従う必要があるかが示されます。

実施の推奨事項にはほとんど常に従う必要があります。次に例を示します。

NuGet パッケージを使用してご利用のライブラリの配布を✔️ 実施してください。

その一方で、検討推奨事項は、一般に実施する必要がありますが、ルールには正当な例外があり、ガイダンスに従っていないことを気する必要はありません。

ご利用の NuGet パッケージのバージョンに SemVer 2.0.0 を使用することを ✔️ 検討してください。

回避の推奨事項は一般には良いアイデアではありませんが、規則に違反することが効果的である場合があります。

❌ 正確なバージョンを要求する NuGet パッケージ参照は回避してください。

最後に、実施しないの推奨事項は、ほとんどの場合でやってはいけないことを示しています。

ご利用のライブラリで、厳密な名前が指定されたバージョンおよび厳密でない名前が指定されたバージョンを ❌ 発行しないでください。たとえば、Contoso.Api とContoso.Api.StrongNamed です。