Как создать аннотированный исходный код, например, underscore.js?

Мне очень нравится аннотированный исходный код, который сопровождает библиотеку underscore.js:

  • Как они это сделали?
  • Есть ли script, который вытащит код комментарии и автосоздание такого рода документации html?

Ответы

Ответ 1

Появляется Docco: http://jashkenas.github.com/docco/

С сайта:

"Docco - это быстрый и грязный, столинейный, генератор документации в стиле грамотного программирования. Он создает HTML, который отображает ваши комментарии рядом с вашим кодом. Комментарии передаются через Markdown, а код передается через Pygments подсветка синтаксиса..."

Ответ 2

ExplainJS.com делает это за вас. Просто вставьте URL-адрес в исходный код, и он хорошо отобразит его в HTML.

enter image description here

Вы также можете использовать параметр .json, если хотите только необработанные данные:

> 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":""
    },
    ...
  ]
}

Полное раскрытие: я построил этот сайт, но это бесплатный сервис.

Ответ 3

Существует также nocco для .NET, shocco для оболочки pycco для python и rocco для рубинов.

Ответ 4

Scala имеет Circumflex Docco. Вы можете найти пример сгенерированной документации здесь.