Freigeben über

Leitfaden zu Bibliotheken

Dieser Leitfaden enthält Empfehlungen für Entwickler zum Erstellen qualitativ hochwertiger .NET-Bibliotheken. Diese Dokumentation konzentriert sich auf das , wasund warum beim Erstellen einer .NET-Bibliothek, nicht auf die Vorgehensweise.

Aspekte hochwertiger .NET-Bibliotheken:

  • Inklusive – Gute .NET-Bibliotheken sind bestrebt, viele Plattformen, Programmiersprachen und Anwendungen zu unterstützen.
  • Stabil – Gute .NET-Bibliotheken sind im .NET-Ökosystem koexistieren, das in Anwendungen ausgeführt wird, die mit vielen Bibliotheken erstellt wurden.
  • Entwickelt für die Entwicklung – .NET-Bibliotheken sollten sich im Laufe der Zeit verbessern und weiterentwickeln und gleichzeitig vorhandene Benutzer unterstützen.
  • Debugbar – .NET-Bibliotheken sollten die neuesten Tools verwenden, um eine großartige Debugumgebung für Benutzer zu erstellen.
  • Vertrauenswürdig – .NET-Bibliotheken vertrauen Entwicklern, indem sie mithilfe bewährter Sicherheitsmethoden in NuGet veröffentlichen.

Erste Schritte

Arten von Empfehlungen

Jeder Artikel enthält vier Arten von Empfehlungen: Do, Consider, Avoid und Do not. Die Art der Empfehlung gibt an, wie stark sie befolgt werden soll.

Sie sollten fast immer eine Do-Empfehlung befolgen. Beispiel:

✔️ DO Verteilen Sie Ihre Bibliothek mithilfe eines NuGet-Pakets.

Auf der anderen Seite sollten Empfehlungen in Betracht gezogen werden, aber es gibt legitime Ausnahmen von der Regel, und Sie sollten sich nicht schlecht fühlen, wenn Sie die Anleitung nicht befolgen:

✔️ ERWÄGEN SIE die Verwendung von SemVer 2.0.0 zur Versionierung Ihres NuGet-Pakets.

Vermeiden Sie Empfehlungen erwähnen Dinge, die in der Regel keine gute Idee sind, aber manchmal ist es sinnvoll, die Regel zu brechen:

❌ VERMEIDEN Sie NuGet-Paketverweise, die eine genaue Version erfordern.

Und schließlich zeigen keine Empfehlungen auf etwas, das Sie fast nie tun sollten:

❌ VERÖFFENTLICHEN SIE KEINE stark benannten und nicht stark benannten Versionen Ihrer Bibliothek. Beispiel: Contoso.Api und Contoso.Api.StrongNamed.

Nächster