Wskazówki dotyczące biblioteki

  • Artykuł

Te wskazówki zawierają zalecenia dla deweloperów dotyczące tworzenia wysokiej jakości bibliotek .NET. Ta dokumentacja koncentruje się na tym, co i dlaczego podczas tworzenia biblioteki .NET, a nie na tym, jak.

Aspekty wysokiej jakości bibliotek platformy .NET:

  • Inkluzywne — dobre biblioteki .NET starają się obsługiwać wiele platform, języków programowania i aplikacji.
  • Stabilne — dobre biblioteki .NET współistnieją w ekosystemie platformy .NET, działające w aplikacjach utworzonych z wieloma bibliotekami.
  • Zaprojektowana pod kątem rozwoju — biblioteki platformy .NET powinny ulepszać i rozwijać się wraz z upływem czasu, jednocześnie obsługując istniejących użytkowników.
  • Debugowanie — biblioteki platformy .NET powinny używać najnowszych narzędzi do tworzenia doskonałego środowiska debugowania dla użytkowników.
  • Zaufane — biblioteki platformy .NET mają zaufanie deweloperów, publikując NuGet przy użyciu najlepszych rozwiązań w zakresie zabezpieczeń.

Wprowadzenie

Typy zaleceń

Każdy artykuł przedstawia cztery typy zaleceń: Wykonaj, Rozważ, Unikaj i Nie. Typ rekomendacji wskazuje, jak silnie należy postępować.

Prawie zawsze należy postępować zgodnie z zaleceniem Wykonaj . Na przykład:

✔️ Dystrybuuj bibliotekę przy użyciu pakietu NuGet.

Z drugiej strony należy rozważyć stosowanie zaleceń, ale istnieją uzasadnione wyjątki od reguły i nie należy czuć się źle, nie postępując zgodnie z wytycznymi:

✔️ ROZWAŻ użycie programu SemVer 2.0.0 do wersji pakietu NuGet.

Unikaj zaleceń, które zazwyczaj nie są dobrym pomysłem, ale łamanie reguły czasami ma sens:

❌UNIKAJ NuGet odwołań do pakietu, które wymagają dokładnej wersji.

I wreszcie, Nie rekomendacje wskazują coś, czego prawie nigdy nie należy robić:

❌ NIE publikuj wersji biblioteki o silnych nazwach i nienazwanych. Na przykład Contoso.Api i Contoso.Api.StrongNamed.

Dalej