Doprovodné materiály ke knihovně

  • Článek

Tyto doprovodné materiály 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, ne 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 spoluexistuje 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 podporovat stávající uživatele.
  • Ladění – 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 NuGet s využitím osvědčených postupů zabezpečení.

Začínáme

Typy doporučení

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

Téměř vždy byste měli postupovat podle doporučení Provést . Příklad:

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

Na druhé straně byste měli zvážit doporučení, která by měla být obecně dodržena, ale existují oprávněné výjimky pravidla a neměli byste mít pocit, že byste neměli dodržovat pokyny:

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

Vyhněte se doporučením zmínit věci, které obecně nejsou vhodné, ale porušení pravidla někdy dává smysl:

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

A nakonec doporučení nenaznačují něco, co byste téměř nikdy neměli dělat:

❌ NEpublikujte verze knihovny se silným názvem a nesdělovat. Příklad: Contoso.Api a Contoso.Api.StrongNamed.

Další