Richtlijnen voor bibliotheken

Deze richtlijnen bieden aanbevelingen voor ontwikkelaars voor het maken van hoogwaardige .NET-bibliotheken. Deze documentatie is gericht op wat enwaarom bij het bouwen van een .NET-bibliotheek, niet op de hoe.

Aspecten van hoogwaardige .NET-bibliotheken:

• Inclusief - Goede .NET-bibliotheken streven ernaar om veel platforms, programmeertalen en toepassingen te ondersteunen.
• Stabiel : goede .NET-bibliotheken bestaan naast elkaar in het .NET-ecosysteem, dat wordt uitgevoerd in toepassingen die zijn gebouwd met veel bibliotheken.
• Ontworpen om te ontwikkelen : .NET-bibliotheken moeten in de loop van de tijd worden verbeterd en ontwikkeld, terwijl bestaande gebruikers worden ondersteund.
• Fouten opsporen: .NET-bibliotheken moeten de nieuwste hulpprogramma's gebruiken om een geweldige foutopsporingservaring voor gebruikers te maken.
• Vertrouwd : .NET-bibliotheken vertrouwen ontwikkelaars door te publiceren naar NuGet met behulp van best practices voor beveiliging.

Aan de slag

Typen aanbevelingen

Elk artikel bevat vier soorten aanbevelingen: Do, Consider, Avoid en Do not. Het type aanbeveling geeft aan hoe sterk deze moet worden gevolgd.

U moet bijna altijd een Do-aanbeveling volgen. Bijvoorbeeld:

✔️ Distribueer uw bibliotheek met behulp van een NuGet-pakket.

Houd daarentegen rekening met aanbevelingen die over het algemeen moeten worden gevolgd, maar er zijn legitieme uitzonderingen op de regel en u moet zich niet slecht voelen over het niet volgen van de richtlijnen:

✔️ Overweeg om SemVer 2.0.0 te gebruiken om uw NuGet-pakket te versiebeheer.

Vermijd aanbevelingen om dingen te vermelden die over het algemeen geen goed idee zijn, maar het breken van de regel soms zinvol is:

❌ VERMIJD NuGet-pakketverwijzingen die een exacte versie eisen.

En ten slotte geven aanbevelingen niet aan dat u bijna nooit moet doen:

❌ PUBLICEER GEEN versies met een sterke naam en niet-sterk benoemde versies van uw bibliotheek. Bijvoorbeeld Contoso.Api en Contoso.Api.StrongNamed.

Volgende