目录 PHP文档生成器(PHPDoc)的基本用法 PHPDoc概述 安装 PHPDoc注释规范 页面级别的注释 代码级别的注释 生成API文档 额外软件 PHP文档生成器(PHPDoc)的基本用法 PHPDoc概述 PHPDoc是一种注释PHP代码的正式标准,一般是通过外部文档生成器phpDocumentor生成API文档.同事支持面向过程和面向对象的代码风格,而且很多高级IDE如PHPStorm对其有很好的支持.灵活使用PHPDoc生成API文档可以有效提高开发效率,本文主要是记录PHPDoc…

一.软件介绍       Sandcastle是一个管理类库的文档编译器,是用于编译发布组件(Assembly)信息的一个工具,这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(命令行编译时加/doc参数或vs2005设置项目属性得到)得到一个完整的帮助文档,格式可以是Html或CHM甚至是任何自定义的格式. Sandcastle与.NET Framework 2.0和.NET Compact Framework组合使用.Sandcastle支持本地化,并提供一个基本的命令行编译器…

简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介 类别:项目文档生成器,生成静态站点,管理MarkDown文档. 官方网址:http://www.mkdocs.org/ 中文文档:http://m…

django-rest-framework,即drf的api文档,包括自带的文档和其他三方文档,比如swagger.DRF Docs等 https://www.django-rest-framework.org/topics/documenting-your-api/#drf-autodocs 可以直接使用本地部署 阿里妈妈前端团队出品的开源接口管理工具RAP第二代 :https://github.com/thx/rap2-delos:第一代已经不维护了:https://github.com/t…

简介 Sphinx 是一个 文档生成器 ,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用.索引等.也就是说,如果您的目录包含一堆 reStructuredText 或 Markdown 文档,那么 Sphinx 就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等. 安装 pip install sphinx 查看是否安装成功 sphinx-build --version 显示对应的版本号即代表安装成功 sphinx-build 5.0.…

当今大多数的团队都实现了前.后端分支.前端与后端的沟通都是通过接口来实现的(一般情况下都是webapi接口).这种情况你肯定需要一个接口查询的帮助文档,这个当然用swagger都可以实现.但做为前端开发的我们是否也应该考虑把自己写的组件以帮助文档的方式公开都团队其他人员使用.就像iview,easyui等UI组件都有自己的帮助文档.今天我们都介绍一套工具(其中某些组件经过本人的改造) 一.需要的组件 1. Hexo:静态博客生成器 2. Hexo-theme-doc:基于Hexo实现的帮助文档类…

在开发接口的过程中,需要向外发布相应的接口文档.开始的时候使用word来写文档,时间长了发现有几个问题. 1. 编写不方便.每次新增借口的时候都要复制上一个接口,然后再进行修改,一些相同的部分无法复用,接口多了文档会变的很长,还经常需要调整格式. 2. 发布不方便.文档更新时,需要发给需要的小伙伴.即使用git来进行管理,虽然拉取比较方便,但由于文件格式的问题,也不方便比较两次提交的差异. 由于有这些问题,决定寻找一种更优雅有效的方式来编写文档.经过比较,发现了apidoc,可以比较好的解决上面…

http://apidocjs.com/ 例子:myapp目录下的MyCode.java /** * * @api {get} /company/list 获取公司信息 * @apiName 获取公司列表 * @apiGroup All * @apiVersion 0.1.0 * @apiDescription 接口详细描述 * * @apiParam {int} pageNum分页大小 * * @apiSuccess {String} code 结果码 * @apiSuccess {Strin…

是否在关闭office文档模板时提示拼写错误语法检查太多而导致失败?如果是提示这个错误的话,可以将拼写检查和语法检查关掉即可.下附相关链接:http://support.microsoft.com/kb/937422/zh-cn…

主要用途:生成API的文档 源码链接:https://github.com/tmcw/docbox 最近刚好在看:Trending in open source,在JS语言中,slate一直在周排行上高居榜首,至少在我看的这一周当中,一直排行第一~ 有点好奇的点进去看了,原来是一款用于生成API文档的东东.本来打算clone下来到本地运行一下,结果ruby那边版本一一直报错,现在都没有解决了,于是乎,看到一个跟跟slate很像的玩意儿,Docbox,为什么要选择它呢? 1.基于Node环境,不需…