microsoft / microsoft/TypeScript
support destructuring parameter @param tag in tsdoc
Abierto
Nadie ha tomado este issue todavía.
Experience Enhancement
Suggestion
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
tsdoc rule:
https://github.com/microsoft/tsdoc/issues/186
vscode issue:
https://github.com/microsoft/vscode/issues/80368
example:
/**
*
* @param bar - the bar parameter
* @param a - the first parameter
* @param b - the second parameter
* @param c - the third parameter
* @returns the return value
*/
function foo(bar: string, {
a,
b,
c
}:{
a: string,
b: number,
c: string
}) {
return bar + a;
}
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
Comienza con el ejemplo de desestructuración y revisa las incidencias vinculadas de TSDoc y VS Code para entender el comportamiento esperado de @param. Localiza la documentación de TypeScript o el tratamiento del language-service para los parámetros desestructurados y añade pruebas que muestren que a, b y c reciben la documentación de parámetros prevista.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- developer-experience, documentation
- 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