Docco 简单方便的项目文档生成器 - 文章教程

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

发布于 2019-07-16 字数 1424 浏览 1717 评论 0

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等等。

如果你对这篇文章有疑问,欢迎到本站 社区 发帖提问或使用手Q扫描下方二维码加群参与讨论,获取更多帮助。

扫码加入群聊

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!

关于作者

JSmiles

生命进入颠沛而奔忙的本质状态,并将以不断告别和相遇的陈旧方式继续下去。

2583 文章
29 评论
84935 人气
更多

推荐作者

Jay

文章 0 评论 0

guowei007

文章 0 评论 0

2668157715

文章 0 评论 0

HY阳

文章 0 评论 0

想挽留

文章 30 评论 3