Microsoft/TypeScript

JSDoc comment for destructuring param: description text not displayed

Open

#24.746 aberto em 7 de jun. de 2018

Ver no GitHub
 (25 comments) (32 reactions) (0 assignees)TypeScript (6.726 forks)batch import
BugDomain: JSDocHelp Wanted

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)

Description

TypeScript Version:
2.9

Search Terms:
JSDoc destructuring param

Code

/**
 * @param {Object} arg
 * @param {number} arg.id - This param description won't show up
 */
function foo({ id }) {}

Expected behavior: In VSCode 1.24.0, when typing foo(, IntelliSense should display the full param description, including its type and text.

Actual behavior: The type is displayed ("number"), but not the text ("This param description won't show up"): image

Related Issues: https://github.com/Microsoft/TypeScript/issues/19645

Additional remark When omitting the {Object} line, the param text shows up correctly: image

Guia do colaborador

Direção de pesquisa
Investigue como o serviço de linguagem do TypeScript analisa as tags JSDoc @param para parâmetros desestruturados, focando no motivo pelo qual o texto da descrição não é exibido no IntelliSense quando o tipo do objeto pai é listado explicitamente. Veja o código fonte relevante em src/services/ e casos de teste.
Pilha de tecnologia
typescript
Domain
developer experience
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptJSDocGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50