1 Repo
Tags used to control the visibility of documentation content in generated outputs.
Distinct from Documentation Comment Generators: Distinct from Documentation Comment Generators: focuses on the specific metadata for hiding content rather than the generation process.
Explore 1 awesome GitHub repository matching programming languages & runtimes · Visibility Modifiers. Refine with filters or upvote what's useful.
TSDoc 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 mechanisms to mark documentation sections as private to exclude them from public API references.