ApiGen

ApiGen 4.0配置项，apigen4.0配置 Usage: generate [-s|--source="..."] [-d|--destination="..."] [--access-levels="..."] [--base-url="..."] [--config="..."] [--google-cse-id="..."] [--google-analytics="..."] [-

转载地址：http://www.th7.cn/Program/php/201501/375666.shtml ApiGen官网: http://www.apigen.org/ 一、从 github 获取 Windows 的安装包 https://github.com/apigen/apigen/downloads 选择 Version x.x.x standalone package (zip)

1.ApiGen是一个工具用于从PHP源代码创建专业的API文档，类似于phpDocumentor/phpDoc。 2.安装apigen wget http://apigen.org/apigen.phar chmod +x apigen.phar mv apigen.phar /usr/local/bin/apigen apigen –version 3.apigen官网： http://www

# 首先，下载ApiGen（http://apigen.org/apigen.phar） # *nix系统 下载phar文件后, 移动到PATH目录中，以保证全局有权限调用 $ mv apigen.phar /usr/local/bin/apigen 现在你可以使用简洁的 apigen 替代 php apigen.phar  # Windows系统 移动phar文件到环境变量PATH任一目录中 打

本文向大家介绍Python文档生成工具pydoc使用介绍，包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项，需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc. pydoc是Python自带的模块，

https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统，参考

easyopen提供一个简单的api文档查看页面，类似于swagger，基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明，也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示： 左边的树形菜单对应文档名称，点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的，需要

CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档，注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境（cabal.debug配置为true）下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

支持在项目中使用 Swagger 注解语法，运行命令，生成 Swagger 文件。 Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。 Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的，和编程语言无关的 API 描述规范。 imi-

Django的admindocs应用从模型、视图、模板标签以及模板过滤器中，为任何INSTALLED_APPS中的应用获取文档。并且让文档可以在Django admin中使用。 在某种程度上，你可以使用admindocs来快为你自己的代码生成文档。这个应用的功能十分有限，然而它主要用于文档模板、模板标签和过滤器。例如，需要参数的模型方法在文档中会有意地忽略，因为它们不能从模板中调用。这个应用仍旧有

原有插件生成的 HTML 文件内容和格式并不理想，考虑自行调整。 因此 fork 了原有仓库，准备动手修改。 这样就有必要能自己从c的源代码开始编译打包。 参考原有的插件打包说明： https://github.com/skyao/protoc-gen-doc/blob/master/BUILDING.md 准备工作 按照要求，需要准备两个东西： Protocol Buffers library

安装 protoc-gen-doc 简单遵循安装要求即可： https://github.com/estan/protoc-gen-doc 安装完成之后的protoc是2.5.0版本，无法处理proto3的文件。因此我们需要升级替换protoc为v3.0.0版本。 升级protoc 使用预编译版本 下载 请先在 protobuf 的 发布页面 中找到对应版本的 download ，然后下载对应版本