V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member Sign In
This topic created in 3911 days ago, the information mentioned may be changed or developed.
RT
日常工作的用Markdown写API文档，感觉有点力不从心。Markdown并不能非常方便地将API文档内容"表达"出来。
想知道大家工作中用到哪些看起来(用起来)比较舒心的文档。
评价标准包括但不限于以下几点：
- 排版
- 清晰地标明传入参数/传出参数/类型
- 方便查找
- 编写文档成本
:)
 |
1
feiyuanqiu Aug 16, 2015  2
|
 |
2
andy12530 Aug 16, 2015 3
|
 |
3
zkd8907 Aug 16, 2015 via iPhone
MSDN
|
 |
4
caonan Aug 16, 2015
MSDN +1，毕竟微软的被欧盟和美国的罚了那么多，DOC 没法不搞好。
|
 |
5
Starduster Aug 16, 2015
dash 算不上很美观但是直观查找快
|
 |
6
ehs2013 Aug 16, 2015
MSDN
|
 |
7
spance Aug 16, 2015
详尽、清晰、分门别类手段齐全的正面例子：
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 Aug 16, 2015 via Android
为毛我觉得man pages就不错，不过msdn确实更好一点
|
 |
9
jsonline Aug 16, 2015 via Android
MDN
|
 |
10
jk2K Aug 16, 2015
用 [api blueprint](https://apiblueprint.org/) 格式去写， [aglio](https://github.com/danielgtaylor/aglio) 去生成页面， 挺美观的
|
 |
11
KaoN Aug 16, 2015
|
 |
12
aaronmix Aug 16, 2015
ReactiveX的很不错： http://reactivex.io/
|
 |
13
eggegg Aug 17, 2015
|
|
14
eggegg Aug 17, 2015
|
 |
15
xiezefan OP @eggegg
@andy12530 devdocs.io 的文档， 我初步看上去，应该只是用 Markdown 渲染。 我现在就是使用这种模式，虽然排版整齐，但 api 多起来看上去就会感觉到混乱， So ，我才想找其他替代方案 |
|
16
xiezefan OP |
|
17
xiezefan OP |
Select Language