Où est la syntaxe pour le fichier d'enregistrement des observations documentées?

Est la syntaxe pour le fichier d'enregistrement des observations documentées n'importe où?

Et par hasard, est-il maintenant de soutenir le C# /// système?

InformationsquelleAutor David Thielen | 2014-04-14
  1. 33

    La bonne syntaxe est maintenant utilisée par les TSDoc. Il vous permettra d'avoir vos commentaires compris par le Code de Visual Studio ou d'autres outils de documentation.

    Un bon aperçu de la syntaxe est disponible ici et surtout ici. Les précis de la spec doit être "bientôt", écrit.

    Un autre fichier de la peine de vérifier est cette une où vous verrez utile balises standard.

    Note: vous ne devez pas utiliser JSDoc, comme expliqué sur TSDoc la page principale: Pourquoi ne peut-JSDoc être la norme? Malheureusement, la JSDoc la grammaire n'est pas rigoureusement précisée, mais plutôt déduit du comportement d'un particulier de la mise en œuvre. La majorité de la norme JSDoc balises sont préoccupés par la fourniture d'annotations de type brut JavaScript, ce qui n'est pas pertinente préoccupation pour un typage fort de la langue tels que des caractères d'imprimerie. TSDoc traite de ces limites, tout aussi de s'attaquer à un plus sophistiqué de buts.

    InformationsquelleAutor Mic
  2. 153

    Tapuscrit utilise JSDoc. par exemple, 

    /** This is a description of the foo function. */
function foo() {
}

    Pour en savoir jsdoc : https://jsdoc.app/

    Où est la syntaxe pour le fichier d'enregistrement des observations documentées?

    Mais vous n'avez pas besoin d'utiliser le type de l'annotation des extensions dans JSDoc.

    Vous pouvez (et devez) utiliser encore d'autres jsdoc bloc tags comme @returns etc.

    Exemple

    Juste un exemple. Focus sur les types (pas le contenu).

    JSDoc version (avis de types dans les docs): 

    /**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

    Tapuscrit version (avis de la re-localisation des types): 

    /**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}
    • Comme les Bas dit! Pour un bon exemple de l'utilisation découvrez la DefinitelyTyped de jQuery.d.ts
    • qui, bien sûr, eu jsdoc ed par @JohnnyReilly! 🙂 github.com/borisyankov/DefinitelyTyped/blame/master/jquery/...
    • Trop à droite! Mais semble impudique pour attirer l'attention sur ça 🙂
    • Ce n'est pas un bon "meilleure réponse" car elle ne permet pas d'expliquer les paramètres, propriétés et valeurs de retour.
    • le lien est cassé maintenant :/
    • Comme cette réponse vient en premier dans les recherches sur le web, je voudrais contribuer sur la façon d'ajouter des paramètres: ci-Dessous la description principale, ajoutez cette ligne: @param parameterName description. Les espaces sont les séparateurs.
    • Mise à jour du lien: github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/...
    • Notez que le double astérisque au début du commentaire n'est pas une faute de frappe. l'écriture d'un style c commentaire est acceptable pour le JS, mais il ne sera pas utilisé comme un JSDoc commentaire. (Pourquoi /** foo / et non /* foo **/ est au-delà de moi....)
    • Ce n'est plus à jour. Voir mise à jour de réponse ci-dessous.

    InformationsquelleAutor basarat
  3. 53

    Vous pouvez ajouter des informations sur les paramètres, retours, etc. ainsi à l'aide de:

    /**
* This is the foo function
* @param bar This is the bar parameter
* @returns returns a string version of bar
*/
function foo(bar: number): string {
    return bar.toString()
}

    Cela va provoquer des éditeurs comme VS le Code pour afficher la suivante:

    Où est la syntaxe pour le fichier d'enregistrement des observations documentées?

    InformationsquelleAutor Sharpiro
  4. 14

    Vous pouvez utiliser les commentaires comme régulièrement JavaScript:

    Tapuscrit syntaxe est un sur-ensemble de l'Ecmascript 5 (ES5) de la syntaxe. [...]

    Ce document décrit la syntaxe de la grammaire ajouté par Tapuscrit

    Autre que cela, je n'ai trouvé ceci à propos des commentaires dans la langue spécifications:

    Tapuscrit fournit également aux programmeurs JavaScript un système d'option annotations de type. Ces annotations sont comme les JSDoc les commentaires figurant dans le système de Fermeture, mais en caractères d'imprimerie, ils sont intégrés directement dans la syntaxe du langage. Cette intégration rend le code plus lisible et réduit le coût d'entretien de la synchronisation des annotations de type avec leurs variables correspondantes.

    11.1.1 Fichiers Source Dépendances:

    Un commentaire de la forme ///<reference path="..."/> ajoute une dépendance sur le fichier source
    spécifié dans l'argument de chemin. Le chemin est résolu relatif au répertoire de l'contenant le fichier source

    Source:

    https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md

    InformationsquelleAutor CoDEmanX
  5. 4

    Tapuscrit est un strict de syntaxe sur-ensemble de JavaScript donc

    • Seule ligne, les commentaires commencent par //
    • Plusieurs lignes de commentaires commencent par /* et se terminent par */
    InformationsquelleAutor Ayushi Jain