6
votes

Quelle est la bonne façon d'écrire du code multiligne dans un commentaire JSDoc dans un projet javascript / typescript dans VSCode?

Lorsque je travaille sur un projet javascript / typescript dans VSCode, je souhaite écrire du code multiligne en commentaire. Sachant que VSCode prend en charge la syntaxe de démarquage dans les commentaires, j'écris:

class TopRow extends React.Component {
    state = {
        /**
        * ```ts
        * { deliverQuestionClicked: { [pageNum]: false } }
        * ```
        */
        deliverQuestionClicked: {},
    };
}

Cependant, lorsque je passe la souris sur cette variable, VSCode rend le commentaire d'une manière moche:

Comme la capture d'écran ci-dessus, il y a * supplémentaire que je ne veux pas.

Je me demande donc quelle est la bonne façon d'écrire du code multiligne dans un commentaire?

Mise à jour 2020/9/25

Je peux confirmer que ce problème n'existe pas dans VSCode 1.49.1

Code:

/**
* ```ts
* { deliverQuestionClicked: { [pageNum]: false } }
* ```
*/
deliverQuestionClicked: {},

typescript visual-studio-code jsdoc

2 commentaires

@Pascalius utilisez-vous des plugins? Je ne vois pas de comportement similaire.

@DipenShah Oui, mais quelle version de VSCode utilisez-vous?

5 Réponses :

-1
votes

vous pouvez utiliser le commentaire multi-lignes de JavaScript qui commence par / * et se termine par * /. Vous n'avez pas besoin de plus *.

0 commentaires

-1
votes

Utilisez simplement / * * / avant et après le commentaire. Par exemple:

/*
This is a multi line comment
I can type on a different line
Without having to worry so far
I close my multi line commen with
an asterix and a backward slash
*/

0 commentaires

0
votes

Au format JSDoc ,

Règles de format de base pour les commentaires JSDoc .

Chaque ligne contient un astérisque et les astérisques doivent être alignés
Chaque astérisque doit être suivi d'un espace ou d'une nouvelle ligne (à l'exception du premier et du dernier)
Les seuls caractères avant l'astérisque sur chaque ligne doivent être des espaces blancs
Les commentaires d'une ligne doivent commencer par / ** et se terminer par */
Les commentaires multilignes n'autorisent pas le texte après / ** dans la première ligne (avec l'option "check-multiline-start" )

Vous pouvez éventuellement spécifier l'option "check-multiline-start" pour forcer la première ligne d'un commentaire JSDoc multiligne à être vide.

`TypeScript dans Visual Studio Code`

Pour désactiver le commentaire JSDoc suggestions dans TypeScript,
set `"typescript.suggest.completeJSDocs": false` .

Pour ajouter un commentaire

appuyez deux fois sur `Ctrl + Alt + C`

ou sélectionnez `"Code de commentaire"` dans votre menu contextuel

ou insérez `/ **` au-dessus de la ligne de code.

En savoir plus visitez

0 commentaires

5
votes

Doit avoir été corrigé.

Dans VSC 1.48 avec ce code

class TopRow {
  state = {
    /**
    * ```ts
    * { deliverQuestionClicked: { [pageNum]: false } }
    * ```
    */
    deliverQuestionClicked: {}
  }
}

J'obtiens

1 commentaires

Oui, je peux également le confirmer dans VSCode 1.49.1. Veuillez consulter ma mise à jour ci-dessus.

-1
votes

Vous pouvez utiliser cette extension: https://marketplace.visualstudio.com/items ? itemName = stevencl.addDocComments . Cela créera automatiquement un commentaire JSDoc pour vous avec un syantax et un placement corrects.

0 commentaires