microsoft / microsoft/TypeScript

JSDoc doesn't show param info for parameter properties using @param

Abierto
#36,356 5 comentarios 11 reacciones 1 asignado Ver en GitHub

@rachelgshaffer ya está trabajando en esto.

Desde el 25/6/2020.

Domain: LS: Quick Info Experience Enhancement Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

TS Template added by @mjbvz

TypeScript Version: 3.8.0-beta

Search Terms

  • quickInfo
  • jsdoc

  • VSCode Version: 1.41.1 (Commit: 26076a4de974ead31f97692a0d32f90d735645c0)
  • OS Version: MacOS Catalina 10.15 (19A602)

Steps to Reproduce:

  1. Create a function with a single parameter
  2. Add documentation to it with object parameter properties contained.
/**
 * Shows a dialog to the user with the given title, content, and performs the onAcceptClick
 * on the accept button press
 *
 * @param {Object} payload - The dialog information to show the user
 * @param {string} payload.title - Title of dialog
 * @param {string} payload.content - Content of the dialog
 * @param {string} [payload.acceptText=null] - Text shown on the accept button
 * @param {Function} [payload.onAcceptClick=null] - Action performed when accept is clicked
 * @param {string} [payload.cancelText=null] - Text shown on the cancel button
 * @param {Function} [payload.onCancelClick=null] - Action performed when cancel is clicked
 */
export const showDialog = (payload) => ({
  type: constants.UPDATE_DIALOG,
  payload,
})

All the parameters show for the method signatures but none of the inner parameter descriptions show. e.g. payload.cancelText does not show the text "Text shown on the cancel button" in the hover event dialog.

Sample

Note as well. Following the sytax defined here the default values do not show anywhere within the pop up. (I can make a separate issue if needed)

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.