这是一个创建于 3385 天前的主题，其中的信息可能已经有所发展或是发生改变。
RT
日常工作的用Markdown写API文档，感觉有点力不从心。Markdown并不能非常方便地将API文档内容"表达"出来。
想知道大家工作中用到哪些看起来(用起来)比较舒心的文档。
评价标准包括但不限于以下几点：
- 排版
- 清晰地标明传入参数/传出参数/类型
- 方便查找
- 编写文档成本
:)
 |
1
feiyuanqiu 2015-08-16 00:54:16 +08:00  2
|
 |
2
andy12530 2015-08-16 01:13:09 +08:00 3
|
 |
3
zkd8907 2015-08-16 01:23:52 +08:00 via iPhone
MSDN
|
 |
4
caonan 2015-08-16 02:27:12 +08:00
MSDN +1，毕竟微软的被欧盟和美国的罚了那么多，DOC 没法不搞好。
|
 |
5
Starduster 2015-08-16 05:32:22 +08:00
dash 算不上很美观但是直观查找快
|
 |
6
ehs2013 2015-08-16 06:23:37 +08:00
MSDN
|
 |
7
spance 2015-08-16 06:52:23 +08:00
详尽、清晰、分门别类手段齐全的正面例子：
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/ 也还有很多。 |
 |
8
ho121 2015-08-16 07:45:25 +08:00 via Android
为毛我觉得man pages就不错，不过msdn确实更好一点
|
 |
9
jsonline 2015-08-16 08:05:04 +08:00 via Android
MDN
|
 |
10
jk2K 2015-08-16 08:59:14 +08:00
用 [api blueprint](https://apiblueprint.org/) 格式去写， [aglio](https://github.com/danielgtaylor/aglio) 去生成页面， 挺美观的
|
 |
11
KaoN 2015-08-16 09:47:42 +08:00
|
 |
12
aaronmix 2015-08-16 13:31:47 +08:00
ReactiveX的很不错： http://reactivex.io/
|
 |
13
eggegg 2015-08-17 16:41:55 +08:00
|
|
14
eggegg 2015-08-17 16:42:20 +08:00
|
 |
15
xiezefan OP @eggegg
@andy12530 devdocs.io 的文档， 我初步看上去，应该只是用 Markdown 渲染。 我现在就是使用这种模式，虽然排版整齐，但 api 多起来看上去就会感觉到混乱， So ，我才想找其他替代方案 |
|
16
xiezefan OP |
|
17
xiezefan OP |
Select Language