reactjs / reactjs/react-docgen
Document TSDoc support
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.8k
- Forks
- 316
- Merge medio
- 5 h 7 min
- PR fusionados (30 d)
- 4
Descripción
Related to #458, but TSDoc (a tool maintained by Miscrosoft) although influenced by JSDoc, has a strictly distinct syntax. For example, @default in JSDOC is @defaultValue in TSDOC. @inheritDoc doesn't have the same semantics, and require an argument in TSDoc... etc.
The full specification is yet to be written, but there is already a very well documented syntax reference here. See https://github.com/microsoft/tsdoc/issues/130 for updates on this specific issue.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza leyendo el issue relacionado #458 y la referencia enlazada de la sintaxis de TSDoc; después, comprueba microsoft/tsdoc#130 para ver las actualizaciones de la especificación. Compara el tratamiento existente de JSDoc con la sintaxis y semántica diferenciadas de TSDoc; se considera terminado cuando la compatibilidad acordada con TSDoc está documentada y validada según la sintaxis referenciada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100