大家都用什么写 api 文档？

[yibin001]

列出所有api，每个api需要的参数列表、参数类型、是否必填、参数说明。
每个api的返回值。

[lizhijun]

markdown？

[yibin001]

@lizhijun
但是要用表格来写参数列表，比较头疼。。

[linnchord]

wiki by markdown

[cnxh]

haroopad

[tolbkni]

@yibin001 Markdown + GFM

[jamiesun]

不用sphinx吗

[lululau]

http://apiary.io

[TangMonk]

bitbucket 的 wiki

[FuryBean]

YuiDoc应该满足楼主的需求。YuiDoc实际上是不限制语言的，而且也不需要写到源码里面。

[TangMonk]

上次做的一个外包, 大家瞟下文档, 有没得啥子可提高的:

https://bitbucket.org/wuao/daxuebao-api/wiki/Home

[davepkxxx]

javadoc

[yibin001]

@lululau
这个不错。

[yibin001]

@lululau 语法也挺蛋疼的。。

[lincanbin]

markdown

[konakona]

哎...只能用excel、word写，用wiki除了我以外没人愿意维护，因为不愿意学wiki的写法...TAT

[shiny]

javadoc / phpdoc 这类语法,自动导出下就行了.

[hehuozhao]

https://readthedocs.org/

[zeayes]

trac wiki

[Winny]

ASP.Net的Web api框架自动生成

[xylophone21]

这个要看语言吧，
c用doxygen
java用javadoc
JS只用NP API做过扩展，没找到太好的方案，现在感觉自定义注释+脚本+latex不错，不过没实施过。

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

猿类都懒

[pantaovay]

markdown 使用 api blueprint生成 很酷炫