Génération de documentation Javascript

Question

Je cherche un moyen de générer automatiquement de la documentation à partir de mon projet Javascript . Quelqu'un sait comment puis-je faire cela?

Autant que je sache, il existe des outils comme JSDoc mais je veux connaître votre avis, votre meilleur choix et pourquoi.

Merci!

EDIT: juste pour être clair, j'ai besoin de quelque chose comme JavaDOC ou PHPDocumentor mais à utiliser avec mon code source Javascript.

Answer 1

Il existe des outils comme Naturel Docs pour ce faire. J'ai personnellement utilisé dans le passé et cela fonctionne très bien avec javascript.

Il existe également des outils comme docco du document code source.

En général, génération automatique de la documentation tend à être trop restrictif et parfois faits à la main de l'API comme le jQuery API sont plus faciles à utiliser.

Également de la documentation pour les langages dynamiques est différente de la documentation sur les langages statiques. Comme l'API sont utilisés de manière différente et état existent plus lâche sens.

Answer 2

J'ai trouvé un bon tutoriel pour créer de la documentation JS à l'aide de JSDoc. J'espère que cela aide à quelqu'un qui en a besoin.

Créez une documentation javascript utile avec JSDoc

C'était exactement ce dont j'avais besoin. Merci pour vos réponses stackers.

Answer 3

SmartComments + YUIDocs

L'aide d'extraordinaire en couple, vous pouvez documenter un grand projet JavaScript en moins d'une minute.

SmartComments, c'est un outil qui vous permettent de créer implicite des commentaires du code source JavaScript.

Vous pouvez utiliser dans la console ou par le biais d'un Sublime Texte Plugin.

S'il vous plaît aller à http://smartcomments.github.io pour de plus amples informations.

Answer 4

autodoc est teh dope; https://www.npmjs.org/package/autodoc | https://github.com/dtao/autodoc

Autodoc vous permet d'écrire des tests dans les commentaires juste au-dessus de vos fonctions JavaScript, puis d'exécuter ces tests à partir de la ligne de commande et l'auto-génération de la documentation avec les mêmes tests intégrés et de l'exécution de droite dans le navigateur.

Pensez lettrés de la programmation, de la regarder http://danieltao.com/lazy.js/docs/ pour un bon exemple. Ces marques vertes sont les tests.

✓ Lazy([1, 2, 4])       // instanceof Lazy.ArrayLikeSequence
✓ Lazy({ foo: "bar" })  // instanceof Lazy.ObjectLikeSequence
✓ Lazy("hello, world!") // instanceof Lazy.StringLikeSequence
✓ Lazy()                // sequence: []
✓ Lazy(null)            // sequence: []

C'est ce que la source ressemble github.com/../lazy.js#L86

/**
 * Wraps an object and returns a {@link Sequence}. For `null` or `undefined`,
 * simply returns an empty sequence (see {@link Lazy.strict} for a stricter
 * implementation).
 *
 * - For **arrays**, Lazy will create a sequence comprising the elements in
 *   the array (an {@link ArrayLikeSequence}).
 * - For **objects**, Lazy will create a sequence of key/value pairs
 *   (an {@link ObjectLikeSequence}).
 * - For **strings**, Lazy will create a sequence of characters (a
 *   {@link StringLikeSequence}).
 *
 * @public
 * @param {Array|Object|string} source An array, object, or string to wrap.
 * @returns {Sequence} The wrapped lazy object.
 *
 *
 * @examples
 * Lazy([1, 2, 4])       // instanceof Lazy.ArrayLikeSequence
 * Lazy({ foo: "bar" })  // instanceof Lazy.ObjectLikeSequence
 * Lazy("hello, world!") // instanceof Lazy.StringLikeSequence
 * Lazy()                // sequence: []
 * Lazy(null)            // sequence: []
 */

Il s'étend JSDoc https://developers.google.com/closure/compiler/docs/js-for-compiler, si en plus vous pouvez avoir de Google closure compiler la vérification et l'optimisation de beaucoup de choses pour vous.

Answer 5

Quel cadre utilisez-vous? (si seulement). Je pense que l'outil que vous choisirez dépendra beaucoup de cela, car idéalement, il devrait comprendre les extensions de classe et tout. Sinon, jsDoc est un bon endroit pour commencer.