Javascript Girl
  1. Javascript Girl
  3. Documentant le code Javascript
Intereting Posts
Un mécanisme standard pour détecter si un JavaScript s'exécute en tant que WebWorker? Le moyen le plus rapide d'ajouter / supprimer plusieurs éléments dans DOM Utilisez javascript pour mettre en pause, passer à la position et régler le volume dans le lecteur Silverlight de netflix Comment obtenir la valeur de la balise h2 pour un div à l'intérieur d'une autre div avec id using javascript Highcharts comment utiliser la variable JavaScript comme source de données série? Rails Multi-Step Form sans Wizard Gem Comment créer une mise en page personnalisée dans un texte sublime 2? JavaScript OOP avec jQuery Mongoose vs mongodb (modules / extensions nodejs), ce qui est mieux? et pourquoi? Comment récupérer le HTML exact comme dans un navigateur Quelles bibliothèques JavaScript sont connues pour utiliser le signe dollar global: fenêtre. $? Comment faire des itérations imbriquées dans jade? En conservant la fonctionnalité de bouton "retour" du navigateur en utilisant AJAX / jQuery pour charger des pages et la méthode history.pushState () JsStringFormat () et apostrophe avec JSON Arrêt de toute exécution javascript

Documentant le code Javascript

Je développe un site qui devient de plus en plus complexe et j'ai donc commencé à documenter mon code.

Pour PHP, j'ai utilisé PHPDocumentor; En tout cas, il semble que tout autre outil (tel que Doxygen) accepte les mêmes étiquettes.

Maintenant, je souhaite documenter le côté JS. Je vois qu'au moins JSDoc et ScriptDoc (et probablement d'autres) existent, et ils acceptent différentes étiquettes, alors je devrais faire un choix. Quelle est la norme (le cas échéant) pour documenter le code Javascript?

Et de plus, comment sont-ils utilisés? Il semble que ScriptDoc est intégré dans le studio Aptana, alors est-il possible de l'utiliser sans IDE?

Il n'y a pas vraiment de manière "standard" de documenter le code JavaScript.

Le projet JSDoc n'est plus actif, vous devriez consulter JsDoc Toolkit .

Il existe d'autres bonnes alternatives, les projets suivants sont assez bons:

  • YUIDoc
  • PDoc

À propos de ScriptDoc , je pense qu'il est axé sur l'activation des fonctions d' aide de code sur Aptana, plutôt que sur la génération de fichiers de documentation.

Il n'existe pas de norme écrasante pour la documentation JS, mais il existe des tendances.

Docco est utilisé par de nombreux projets JS populaires et actifs, dont Backbone & Underscore. C'est simple et présente d'excellents exemples sur la page d'accueil.

JSDoc Toolkit est plus ancien et moins populaire pour les nouveaux projets. Le site JSDoc n'a pas non plus d'exemples de code JSDoc. Il nécessite également Rhino, qui peut être difficile à installer sur Windows par rapport à NodeJS.