Doprovodné materiály ke knihovnám

Tyto pokyny poskytují vývojářům doporučení k vytváření vysoce kvalitních knihoven .NET. Tato dokumentace se zaměřuje na to, co a proč při vytváření knihovny .NET, nikoli na způsobech.

Aspekty vysoce kvalitních knihoven .NET:

• Inkluzivní – dobré knihovny .NET se snaží podporovat mnoho platforem, programovacích jazyků a aplikací.
• Stabilní – dobré knihovny .NET spolu existují v ekosystému .NET a běží v aplikacích vytvořených s mnoha knihovnami.
• Navržené tak, aby se vyvinuly – knihovny .NET by se měly v průběhu času zlepšovat a vyvíjet a současně podporovat stávající uživatele.
• Laditelné – knihovny .NET by měly používat nejnovější nástroje k vytvoření skvělého prostředí ladění pro uživatele.
• Důvěryhodné – knihovny .NET mají důvěru vývojářů publikováním do NuGetu s využitím osvědčených postupů zabezpečení.

Začít

Typy doporučení

Každý článek obsahuje čtyři typy doporučení: Do, Zvažte, Vyhněte se a Ne. Typ doporučení označuje, jak silně se má dodržovat.

Téměř vždy je vhodné postupovat podle doporučení Dělat. Například:

✔️ Distribuujte knihovnu pomocí balíčku NuGet.

Na druhou stranu by se doporučení Consider měla obecně dodržovat, ale existují oprávněné výjimky z pravidla a neměli byste se cítit špatně, pokud nerespektujete poradenství:

✔️ Zvažte použití SemVer 2.0.0 k verzi balíčku NuGet.

Vyhněte se doporučením, které zmiňují věci obecně nepovažované za dobrý nápad, ale porušení pravidla někdy dává smysl:

❌ Vyhněte se odkazům na balíčky NuGet, které vyžadují přesnou verzi.

A nakonec, nedělejte něco, co byste téměř nikdy neměli dělat:

❌ NEpublikujte verze své knihovny se silným názvem ani bez něj. Příklad: Contoso.Api a Contoso.Api.StrongNamed.

Další