1 Repo
Awesome GitHub RepositoriesDocumentation Default Values
Tags used to explicitly document the default values of API members.
Distinct from Schema Default Values: Distinct from Schema Default Values: focuses on the documentation of the value rather than the runtime assignment.
Explore 1 awesome GitHub repository matching software engineering & architecture · Documentation Default Values. Refine with filters or upvote what's useful.
Awesome Documentation Default Values GitHub Repositories
Finde die besten Repos mit KI.Wir suchen mit KI nach den am besten passenden Repositories.
- microsoft/tsdoc
microsoft/tsdoc
4,954Auf GitHub ansehenTSDoc ist ein Dokumentationsstandard und eine Spezifikation für das Schreiben strukturierter Kommentare in TypeScript-Code. Es bietet ein portables System zur Definition von Metadaten, Tags und Querverweisen innerhalb des Quellcodes, um eine konsistente Analyse und Darstellung über verschiedene Toolings hinweg zu gewährleisten. Das Projekt enthält einen Doc-Kommentar-Parser, der Kommentare in einen strukturierten Syntaxbaum umwandelt, sowie einen Validator, der die Syntaxkonsistenz erzwingt. Es ermöglicht die Definition benutzerdefinierter Dokumentations-Tags über externe Konfigurationsdateien und unterstützt mehrere Syntax-Validierungsmodi, um die Einhaltung der Spezifikation zu unterstützen. Die Spezifikation deckt eine breite Palette von API-Dokumentationsanforderungen ab, einschließlich der Kennzeichnung von Release-Stufen, Stabilität und Deprecation. Sie unterstützt die Detaillierung von Funktionsparametern, Rückgabewerten und Exception-Typen sowie die Verwaltung von interner Sichtbarkeit, Vererbung und Querverweisen zwischen Deklarationen.
Provides a standard way to specify the default value for a member in the documentation.
TypeScriptcommentsdoc-commentsdocumentation
