Comment créer un code source annoté comme underscore.js ?

Question

J'aime beaucoup le code source annoté qui accompagne la bibliothèque underscore.js : http://documentcloud.github.com/underscore/docs/underscore.html

1. Comment ont-ils fait ?
2. Existe-t-il un script qui sortirait le code commentaires et créer automatiquement ce genre de documentation html ?

Answer 1

Semble être Docco : http://jashkenas.github.com/docco/

---

Du site :

"Docco est un générateur de documentation rapide et sale, de cent lignes, dans le style de la programmation littéraire. Il produit du HTML qui affiche vos commentaires à côté de votre code. Les commentaires sont passés par Markdown, et le code est passé par la coloration syntaxique Pygments. ..."

Answer 2

ExplainJS.com le fait pour vous. Il suffit de coller l'URL de votre code source pour qu'il soit joliment rendu en HTML.

Vous pouvez également utiliser le .json si vous ne voulez que les données brutes :

> curl http://explainjs.com/explain.json?src=http://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone.js

{
  "src": "http://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone.js",
  "title":"backbone.js",
  "sections": [
    {
      "comments":"<p>Backbone.js 1.0.0</p>",
      "code":""
    },
    ...
  ]
}

Divulgation complète : j'ai construit ce site, mais c'est un service gratuit.

Answer 3

Il existe également nocco pour .NET, shocco pour l'obus, pycco pour python, et rocco pour ruby.

Answer 4

Scala a Circumflex Docco . Vous pouvez trouver un exemple de la documentation générée ici .