Руководство по библиотекам

В этом руководстве содержатся рекомендации для разработчиков по созданию высококачественных библиотек .NET. В этой документации основное внимание уделяется тому, что и почему при создании библиотеки .NET, а не о том, как.

Аспекты высококачественных библиотек .NET:

• Инклюзивные — хорошие библиотеки .NET стремятся поддерживать множество платформ, языков программирования и приложений.
• Стабильный — хорошие библиотеки .NET сосуществуют в экосистеме .NET, работающей в приложениях, созданных со многими библиотеками.
• Разработанная для развития — библиотеки .NET должны улучшаться и развиваться с течением времени, поддерживая существующих пользователей.
• Отлаживаемые библиотеки .NET должны использовать последние средства для создания отличного интерфейса отладки для пользователей.
• Доверенные библиотеки .NET имеют доверие разработчиков, публикуя в NuGet, используя рекомендации по безопасности.

Начало работы

Типы рекомендаций

Каждая статья содержит четыре типа рекомендаций: "Делать", "Учитывать", "Избегать" и "Не делать". Тип рекомендации указывает, насколько строго следует следовать.

Почти всегда следует следовать рекомендации Do. Рассмотрим пример.

✔️ ДО распространяйте вашу библиотеку с помощью пакета NuGet.

С другой стороны, Рассматривая рекомендации, обычно следует их соблюдать, но существуют допустимые исключения из правила, и вы не должны переживать, если не следуете этим советам.

✔️ Рекомендуется использовать SemVer 2.0.0.0 для версии пакета NuGet.

Избегайте рекомендаций упоминать вещи, которые обычно не являются хорошей идеей, но нарушение правила иногда имеет смысл:

❌ Избегайте ссылок на пакеты NuGet, требующие точной версии.

И, наконец, рекомендации, в которых говорится не, указывают на то, чего вам почти никогда не следует делать:

❌ НЕ публикуйте строго именованные и нестрого именованные версии библиотеки. Например, Contoso.Api и Contoso.Api.StrongNamed.

Далее