php 接口文档编写工具,适合写接口文档的工具,或者文本语法

由于后端与前端使用ajax交互,后端写接口文档变得非常有必要。以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn、git等无法自动合并word。所以打算把文档写成文本的格式。

一开始想到的是用markdown语法来写。markdown语法大全

但是接口文档最重要的一个特性是,接口多,需要给每个接口标序号(如下图)。

当然markdown支持序号,但是支持得并不完美,比如上下两个序号之间最多只能有一个空行,并且空行不能写文字,这样就只能光写接口标题了,没有空间写接口内容了。

请问适合写接口文档的方法是什么?最好就是一种语法,而不是一个软件

bVZLaP?w=1414&h=1140

感谢大家的回答,考虑到markdown目前的趋势,还是决定继续使用markdown,现在已经想到解决办法,markdown只是一种语法,到底怎么显示,还是由软件或者浏览器插件来决定的,我找到两款chrome插件

Markdown Preview Plus

能自动把原文中的标题提取出来生成目录,并且能给目录自动加序号(如果原文标题本身就有序号,它也会加自己的序号,所以原文标题不能有序号)

bVZM2a?w=1015&h=911

Markdown Viewer

同样能把原文中的标题提取出来生成目录,但是不会加序号,对于不需要序号,或者接口较少的,可以用这个,我更喜欢这个插件的目录样式,可惜功能缺了一点。

bVZM21?w=1097&h=879

这两款插件其实是提供给文档阅读者的,文档编辑者倒是可以不需要,全看个人喜好了,chrome官方市场里就找到这两款了,不知道国内有没有人开发了插件没传到chrome市场

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值