你们觉得用测试代替文档可行吗？

[sunjourney]

写的库纯粹给程序员使用，代码更新还要同时维护文档，不仅要考虑行文、考验文笔，有时还要分中英版本。这么看其实挺麻烦的，干脆把 api 测试和集成测试的 IO 扔到 README 里，天然的 user guide + document （测试注释） + api reference，感觉就该这么干。

[Rubbly]

不行，测试和文档的目的不一样，你所说的方式只能达到测试和文档的功能交集，除开交集之外的部分，两者都没办法达到理想的效果。

[wxsm]

“写的库纯粹给程序员用”

？？？

[sunjourney]

@Rubbly #1 主要的功能应该齐了，读测试，怎么用，api 签名，设计时设想的用法都有了。能想到的只有在文档会提些心路历程啥的：这里为什么不支持 xxx 这样调用；为什么不实现成 xxx 样是因为 xxx ；可以结合 yyy 库，实现 zzz 功能。不过这些东东可以作为补充或者放到合适的注释位置，并没有问题。我有时读不明白，读源码太累，读测试刚刚好。