Руководство по библиотекам
В этом руководстве приводятся рекомендации для разработчиков по созданию высококачественных библиотек .NET. Документация в основном освещает, что следует делать при создании библиотеки .NET и почему, не останавливаясь на способах достижения.
Признаки высококачественных библиотек .NET:
- Инклюзивные — хорошие библиотеки .NET поддерживают разнообразные платформы, языки программирования и приложения.
- Стабильные — хорошие библиотеки .NET сосуществуют в экосистеме .NET, позволяя запускать приложения, собранные с использованием множества библиотек.
- Развивающиеся — библиотеки .NET со временем должны улучшаться и совершенствоваться, одновременно предоставляя поддержку существующим пользователям.
- Отлаживаемые — библиотеки .NET должны использовать новейшие средства для создания отличных возможностей отладки для пользователей.
- Доверенные — библиотеки .NET завоевывают доверие разработчиков, если публикуются в NuGet с использованием рекомендаций по безопасности.
Типы рекомендаций
В каждой статье приводится список рекомендаций таких типов: Do, Consider, Avoid и Do not. Тип рекомендации свидетельствует о том, насколько строго следует придерживаться рекомендации.
Рекомендациям Do нужно следовать практически всегда. Пример:
✔️ DO Распространение библиотеки с помощью пакета NuGet.
Рекомендациям Consider обычно также нужно следовать, за некоторыми допустимыми исключениями. Если вы не придерживаетесь такой рекомендации, это не страшно:
✔ РЕКОМЕНДУЕТСЯ использовать SemVer 2.0.0 для управления версиями пакета NuGet.
Рекомендации Avoid обычно относятся к нежелательным действиям, но иногда их можно нарушать.
❌ НЕЖЕЛАТЕЛЬНО использовать ссылки на пакеты NuGet, требующие указания точной версии.
Рекомендации Do not указывают на то, чего практически никогда не следует делать.
❌ НЕ СЛЕДУЕТ публиковать версии библиотеки со строгим и нестрогим именем. Например, Contoso.Api и Contoso.Api.StrongNamed.