• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

nlf/ape: API document generation for github made simple

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

nlf/ape

开源软件地址:

https://github.com/nlf/ape

开源编程语言:

JavaScript 100.0%

开源软件介绍:

ape

API docs? Nope, ape docs!

ape generates API documentation in github-flavored-markup from comments in your code, and places them in line with the actual code. This allows for very easy integration with github. Optionally, ape can also output to html with a built-in jade template, or one you specify.

See lib/template.jade for an example template, lib/ape.html and lib/ape.md are example output.

To install:

sudo npm install -g ape

And how to use:

Usage: node ./bin/ape [input file|directory list]

Options:
  --md            Output as markdown        [boolean]  [default: true]
  --html          Output as HTML            [boolean]  [default: false]
  --template, -t  Template for HTML output  [string]
  --output, -o    Output directory          [string]

Currently python, javascript, ruby, lua, coffeescript, C, C++, Perl, PHP, C#, ObjC, SQL, Bash, CSS, and ActionScript are supported. Feel free to submit a pull request for additional languages!




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap