1 repositorio
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.
TSDoc es un estándar de documentación y especificación para escribir comentarios estructurados en código TypeScript. Proporciona un sistema portátil para definir metadatos, etiquetas y referencias cruzadas dentro del código fuente para garantizar un análisis y renderizado consistentes en diferentes herramientas. El proyecto incluye un analizador de comentarios de documentación que convierte los comentarios en un árbol de sintaxis estructurado y un validador que aplica la consistencia de la sintaxis. Permite la definición de etiquetas de documentación personalizadas a través de archivos de configuración externos y admite múltiples modos de validación de sintaxis para ayudar con el cumplimiento de la especificación. La especificación cubre una amplia gama de necesidades de documentación de API, incluyendo el marcado de etapas de lanzamiento, estabilidad y obsolescencia. Admite detallar parámetros de funciones, valores de retorno y tipos de excepciones, así como gestionar la visibilidad interna, la herencia y las referencias cruzadas entre declaraciones.
Provides a standard way to specify the default value for a member in the documentation.