Docco 简单方便的项目文档生成器

Question

Docco 是一个快速而随意、hundred-line-long、迭代程序风格的文档生成器。它会以HTML的方式显示评论和代码。

 ____
/\  _`\
\ \ \/\ \        ___         ___         ___         ___
 \ \ \ \ \      / __`\      /'___\      /'___\      / __`\
  \ \ \_\ \    /\ \ \ \    /\ \__/     /\ \__/     /\ \ \ \
   \ \____/    \ \____/    \ \____\    \ \____\    \ \____/
    \/___/      \/___/      \/____/     \/____/     \/___/

Docco 是一个应急用的文档生成器。使用 Literate CoffeeScript 编写。可生成 HTML 文档来显示你在代码中的注释。使用 Markdown 语法，代码通过 Pygments 语法高亮。

1. 安装 Docco 通过 npm： sudo npm install -g docco
2. 运行测试代码通过： docco src/*.coffee

这将产生一个 HTML 页面的命名源文件，用点击菜单链接到其他页面，所有乱七八糟的东西保存到docs文件夹（保存位置可配置）。

Docco 的源代码可以在GitHub上找到，在 MIT 许可下发布。 Docco 可以在任何编程语言编写的程序代码。如果它不能处理你最喜欢的，感觉自由添加到列表中。最后“任何语言的人”的风格也支持，只是附加一个.md延长结束.coffee.md, .py.md等等。

• 官方文档：http://ashkenas.com/docco/
• Github：https://github.com/jashkenas/docco