大家都用什么写 api 文档？

2014-09-19 10:36:17 +08:00
 yibin001
列出所有api，每个api需要的参数列表、参数类型、是否必填、参数说明。
每个api的返回值。
6992 次点击
所在节点    问与答
21 条回复
lizhijun
2014-09-19 10:39:17 +08:00
markdown？
yibin001
2014-09-19 10:44:14 +08:00
@lizhijun
但是要用表格来写参数列表，比较头疼。。
linnchord
2014-09-19 10:44:18 +08:00
wiki by markdown
cnxh
2014-09-19 10:49:16 +08:00
haroopad
tolbkni
2014-09-19 10:59:47 +08:00
@yibin001 Markdown + GFM
jamiesun
2014-09-19 11:02:19 +08:00
不用sphinx吗
lululau
2014-09-19 11:06:55 +08:00
http://apiary.io
TangMonk
2014-09-19 11:10:03 +08:00
bitbucket 的 wiki
FuryBean
2014-09-19 11:11:30 +08:00
YuiDoc应该满足楼主的需求。YuiDoc实际上是不限制语言的，而且也不需要写到源码里面。
TangMonk
2014-09-19 11:12:11 +08:00
上次做的一个外包, 大家瞟下文档, 有没得啥子可提高的:

https://bitbucket.org/wuao/daxuebao-api/wiki/Home
davepkxxx
2014-09-19 11:12:25 +08:00
javadoc
yibin001
2014-09-19 11:29:57 +08:00
@lululau
这个不错。
yibin001
2014-09-19 11:32:38 +08:00
@lululau 语法也挺蛋疼的。。
lincanbin
2014-09-19 11:56:27 +08:00
markdown
konakona
2014-09-19 12:23:46 +08:00
哎...只能用excel、word写，用wiki除了我以外没人愿意维护，因为不愿意学wiki的写法...TAT
shiny
2014-09-19 12:25:03 +08:00
javadoc / phpdoc 这类语法,自动导出下就行了.
hehuozhao
2014-09-19 12:35:32 +08:00
https://readthedocs.org/
zeayes
2014-09-19 12:49:49 +08:00
trac wiki
Winny
2014-09-19 16:59:25 +08:00
ASP.Net的Web api框架自动生成
xylophone21
2014-09-19 20:42:42 +08:00
这个要看语言吧，
c用doxygen
java用javadoc
JS只用NP API做过扩展，没找到太好的方案，现在感觉自定义注释+脚本+latex不错，不过没实施过。

总之，个人的感觉是接口文档不写在代码里就等于没写，根本没人看，同步也非常麻烦。

猿类都懒

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/134415

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX