Útmutató a könyvtárhoz
Ez az útmutató javaslatokat nyújt a fejlesztőknek, hogy kiváló minőségű .NET-kódtárakat hozzanak létre. Ez a dokumentáció a .NET-kódtárak készítésének módját és okát ismerteti, nem pedig a módját.
A kiváló minőségű .NET-kódtárak jellemzői:
- Befogadó – A jó .NET-kódtárak számos platform, programozási nyelv és alkalmazás támogatására törekednek.
- Stabil – A jó .NET-kódtárak együtt léteznek a .NET-ökoszisztémában, és számos kódtárból készült alkalmazásokban futnak.
- Fejlesztésre tervezve – A .NET-kódtáraknak idővel javulnia és fejlődnie kell, miközben támogatniuk kell a meglévő felhasználókat.
- Hibakeresés – A .NET-kódtáraknak a legújabb eszközökkel kell nagyszerű hibakeresési élményt létrehozniuk a felhasználók számára.
- Megbízható – A .NET-kódtárak a fejlesztők bizalmát élvezik azáltal, hogy biztonsági ajánlott eljárásokat használva tesznek közzé a NuGetben.
Javaslatok típusai
Minden cikk négyféle javaslatot mutat be: Do, Consider, Avoid és Do not. A javaslat típusa azt jelzi, hogy milyen erősen kell követni.
Szinte mindig követnie kell egy Do-javaslatot . Például:
✔️ A DO nuGet-csomag használatával terjeszti a kódtárat.
Másfelől általában érdemes megfontolni a javaslatok betartását, de vannak jogos kivételek a szabály alól, és nem szabad rosszul éreznie magát amiatt, hogy nem követi az útmutatást:
✔️ Fontolja meg a SemVer 2.0.0-s verziójának használatát a NuGet-csomag verziójához.
Kerülje a javaslatok említését, amelyek általában nem jó ötlet, de a szabály megszegése néha értelmes:
❌ KERÜLJE A Pontos verziót igénylő NuGet-csomaghivatkozásokat.
És végül, ne javaslatok jelzik valamit, amit szinte soha nem kell tennie:
❌ NE tegye közzé a kódtár erős elnevezett és nem erős nevű verzióit. Például: Contoso.Api és Contoso.Api.StrongNamed.