Je recherche un framework de documentation API Javascript avec des fonctionnalités similaires à JSDoc, mais j'utiliserais un texte restructuré simple ou différent dans les commentaires de code (pas html) Bonus: s'intègrent bien avec Sphinx. Cependant, je ne veux pas conserver une documentation distincte, mais générer de la documentation API à partir des commentaires. Http://code.google.com/p/jsdoc-toolkit/
Je retourne Immutable.js Liste la structure des données à partir de la fonction. PHPStorm attache automatiquement les suivantes @returns {*|List<T>|List<any>} . Eslint me donne l'avertissement La variable non résolue du type 'T'. Où puis-je trouver de la documentation pour les annotations pour Immutable.js? Comment décrire dans la forme d'annotation @returns de la liste qui passerait […]
Comment documenter les mixins ou l'héritage multiple? /** * @class Parent */ function Parent() { } Parent.prototype.parentTest = 5; /** * @class Mixin */ function Mixin() { } Mixin.prototype.mixinTest = 5; /** * @class Child * @augments Parent * @mixin Mixin */ function Child() { } Y at-il quelque chose de officiel de JsDoc? Sinon, […]
Afin d'éviter d'utiliser de new dans mon code JavaScript, j'écris des usines pour créer des objets. J'ai essayé de nombreuses combinaisons et celle qui me donne le résultat le plus satisfaisant est la suivante: /** * Document module * @module app/document */ (function () { 'use strict'; /** * Factory that creates a document object. […]
Je tente de bien commenter mon javascript et j'utilise JSDoc. J'ai une fonction qui consomme un objet jquery et je voudrais marquer le paramètre en tant que tel. À l'heure actuelle, j'ai ceci: /** * Initializes a login object. * @param formEl {JQuery} The login form element on the page. */ var login = function(formEl){ […]
La page UseJSDoc.org sur @type explique comment documenter les tableaux et les objets, mais pas les tableaux d' objets. Ma fonction accepte un ensemble d'objets avec une liste spécifique de propriétés et ce sont ces propriétés que j'aimerais documenter. La fonction pourrait ressembler à la function foo(people) et le tableau des people aurait pu être […]
Je m'occupe d'un modèle de module dans l'inspection en direct de WebStorm que j'essaie de commenter. Et je ne veux pas utiliser AMD / CJS. ; My = (window.My || {}); My.Module = (My.Module || {}); My.Module.MyClass = (/** * * @param {My.Module.MyAnotherClass} MyAnotherClass */ function (MyAnotherClass) { 'use strict'; /** * @class */ var […]
Nous utilisons JSDOC pour documenter notre SDK orienté vers le client et nous avons du mal à reconnaître nos «énommes» (c.-à-d. Les constantes). Quelles étiquettes devrions-nous utiliser pour que JSDOC puisse la récupérer dans la documentation? Voici un exemple: /** * @module Enum */ export namespace { /** * @enum WidgetType {string} */ Enum.WidgetType = […]
J'essaie d'automatiser un module particulier dans notre bibliothèque JS et je suis coincé à un point où je veux définir un ensemble de propriétés (disons un objet qui se présente comme paramètre de construction d'une classe). /** * This function initiates world peace! * @constructor * @param {object} defaults – The options to initiate peace. […]
Est-il possible d'utiliser un énoncé pour la déclaration de type JSDoc @param comme dans l'exemple suivant? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { } Si j'utilise un IDE comme Eclipse etc. pour JavaScript, […]