分享 不管你是在写 Ruby,还是 JS,还是 PHP,还是 Elixir... Doctest 能帮助你写更好的代码

fredwu · 发布于 2017年08月07日 · 最后由 5swords 回复于 2017年08月10日 · 690 次阅读
188

刚写了一篇博文,介绍 Elixir 里的 Doctest 这个功能。但是文章的中心思想并不是 Elixir,而是运用 Doctest 来帮助你写更好的代码。欢迎来拍砖,英文需翻墙。😈

http://fredwu.me/post/163901408538/elixir-and-doctest-help-writing-better-programs

共收到 5 条回复
96

我也要开始在方法前写文档了,写文档有助于思考。

1232
32w7938940 回复

Elixir 的 doctest 不只是文档,还是测试

7072

我对 doctest 的期待是,有例子的文档,并且这些例子是可以跑的通的。 写注释的时候,写例子方便理解和调试。

doctest 里,如果测试特别多的时候,会对阅读有影响。测试变复杂的时候,doctest 也会显得比较吃力。

鼓励在注释里写例子,但能作为测试,只是 bonus。

7643

doctest 是文档也是单元测试,写起来很顺手。而单元测试,能帮助你思考结构,写更好的代码。

没有 doctest 特性的语言,也用 elixir 的 doctest 的思路给每个方法写 example doc 和 unit test,这样能帮助你写更好的代码。

感觉楼主的标题微言大义,需要解释。

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册