大家工作中使用过哪些看上去赏心悦目的 API 文档

[xiezefan]

RT

日常工作的用Markdown写API文档，感觉有点力不从心。Markdown并不能非常方便地将API文档内容"表达"出来。

想知道大家工作中用到哪些看起来(用起来)比较舒心的文档。

评价标准包括但不限于以下几点：

• 排版
• 清晰地标明传入参数/传出参数/类型
• 方便查找
• 编写文档成本

:)

[feiyuanqiu]

https://apiary.io

[andy12530]

http://devdocs.io/

[zkd8907]

MSDN

[caonan]

MSDN +1，毕竟微软的被欧盟和美国的罚了那么多，DOC 没法不搞好。

[Starduster]

dash 算不上很美观但是直观查找快

[ehs2013]

MSDN

[spance]

详尽、清晰、分门别类手段齐全的正面例子：
http://docs.oracle.com/javaee/6/api/
http://golang.org/pkg/
http://docs.oracle.com/cd/E11882_01/server.112/e41084/toc.htm
还有很多。

缺少返回值类型、入参类型、可能抛出的异常，混乱不堪、拖沓冗长、把examples当解释、掺入用户评论干扰文档等的反面例子：
https://docs.python.org/2/library/
也还有很多。

[ho121]

为毛我觉得man pages就不错，不过msdn确实更好一点

[jsonline]

MDN

[jk2K]

用 [api blueprint](https://apiblueprint.org/) 格式去写， [aglio](https://github.com/danielgtaylor/aglio) 去生成页面， 挺美观的

[KaoN]

http://doc.qt.io/

[aaronmix]

ReactiveX的很不错： http://reactivex.io/

[eggegg]

http://devdocs.io/

[eggegg]

http://devdocs.io/ +1

[xiezefan]

@eggegg
@andy12530

devdocs.io 的文档， 我初步看上去，应该只是用 Markdown 渲染。 我现在就是使用这种模式，虽然排版整齐，但 api 多起来看上去就会感觉到混乱， So ，我才想找其他替代方案

[xiezefan]

@jk2K
@feiyuanqiu

感觉 apiary.io 生成的页面有点复杂， api blueprint 似乎更好一点，初步了解。回头再仔细研究研究

[xiezefan]

@jk2K
@feiyuanqiu 额，又了解了下，两个项目好像是有依赖关系的。 总之，谢谢两位了。