依照惯例,
一、介绍 apidoc
apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生成文档。 目前支持支持以下语言:C#、C/C++、D、Erlang、Go、Groovy、Java、JavaScript、Pascal/Delphi、 Perl、PHP、Python、Ruby、Rust、Scala 和 Swift。
官方文档可参考:http://apidocjs.com
本文档中的所有示例都使用Javadoc样式(可用于C#,Go,Dart,Java,JavaScript,PHP,TypeScript和所有其他支持Javadoc的语言):
/**
* This is a comment.
*/
对于其他语言,请使用其特定的多行注释代码: CoffeeScript 的
###
This is a comment.
###
Elixir
@apidoc """
This is a comment.
"""
Erlang (注释中的‘%’是可选的)
%{
% Thisisa comment.
%}
Python
"""
This is a comment.
"""
Ruby
=begin
This is a comment.
=end
Lua
--[[
This is a comment.
--]]
二、apidoc 的使用
1、安装
npm install apidoc -g
2、运行
apidoc -i myapp/ -o apidoc/ -t mytemplate/
3、apidoc 命令参数列表:
参数 描述
网友评论