microsoft / microsoft/TypeScript
Intellisense behaviour of functions and parameters
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
Some odd/unintuitive Intellisense behaviour:
/**
* Function description A
* @param name Parameter description A
*/
function uniqueName(name: string): string {
}
export const Uid = {
/**
* Function description B
* @param name Parameter description B
*/
uniqueName
};
The intellisense description for the 'Uid.uniqueName' property is now description B, however the intellisense for the parameter is description A. There isn't anything overriding here - the description of the function is always taken from the export, and the parameter description is always taken from the function definition. As such, I need to do the following to get full intellisense support for this pattern:
/**
* @param name Parameter description
*/
function uniqueName(name: string): string {
}
export const Uid = {
/**
* Function description
*/
uniqueName
};
i.e. function definitions in one place, parameter definitions in another place. I know I can work around this by restructuring the code, but it still feels like I should be able to achieve it in the above format.
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
No se especifica ningún archivo de origen ni ninguna prueba. Reproduce los ejemplos de TypeScript IntelliSense del issue y sigue cómo se selecciona la documentación de la propiedad exportada y del parámetro de la función; se considera terminado cuando tanto la descripción documentada de la función como la descripción del parámetro proceden de las declaraciones esperadas, sin reestructurar el código.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100