Skip to content

huangzworks/clojure_api_cn

Repository files navigation

关于

这是 Clojure 官方 API 文档 clojure.github.com/clojure 的中文翻译版本。

在线阅读地址: clojure-api-cn.readthedocs.org

翻译进度

模块 进度 译者
clojure.core 进行中 huangz , Lin Xiangyu , yaphet
clojure.data  
clojure.inspector  
clojure.java.browse 已完成 Lin Xiangyu
clojure.java.io 已完成 Qiu Xiafei
clojure.java.javadoc 已完成 Lin Xiangyu
clojure.java.shell 已完成 Lin Xiangyu
clojure.main  
clojure.pprint 进行中 sectic
clojure.reflect  
clojure.repl 进行中 simlegate
clojure.set 已完成 Qiu Xiafei
clojure.stacktrace  
clojure.string 已完成 huangz
clojure.template  
clojure.test 进行中 yfwu
clojure.walk  
clojure.xml 已完成 Lin Xiangyu
clojure.zip  

如何加入翻译?

  1. 选定你要翻译的函数/宏/模块,到项目 github 的 issue 页面开一个 issue ,将你要翻译的内容写下来(为避免出现多人翻译同一项内容的情况,请确保你要翻译的内容没有其他人在翻译)。
  2. 如果你要翻译的是一整个模块的内容,请在“翻译进度”表中将相应模块的进度从“无”更改为“进行中”,并在“译者”一栏加上你的名字和链接。
  3. 开始翻译!
  4. 完成,提交翻译到 repo ,并在“翻译进度”表中将相应模块的状态改为“已完成”。
  5. (recur step-1)

以下是一些翻译时需要注意的地方:

  • 庞大的 clojure.core 模块需要多人来共同翻译,只要里面的某个函数/宏没有别人在翻译,你就可以翻译它。
  • 最好以单个函数/宏为单位,小段小段地 push 自己的翻译,不要将大一块翻译凑到一起来 push ,小段的内容更容易被检查
  • 碰到不好翻译的地方,或者需要任何帮助,开 issue 讨论
  • 对于一些没有标准翻译的词语,请使用“翻译(原文)”的格式做标记,比如: 柯里化(currying) 。这种标记同一个页面里做一次就可以了。
  • 如果模块文档没有提供相应的测试代码,可以参考 ClojureDocs 上面的测试代码,也可以自己添加测试代码。

对以上规则有任何疑问或建议,请开 issue 或者联系 huangz

参考资料

Clojure 官方文档: clojure.org/documentation

Clojure API 手册: clojure.github.com/clojure

Clojure Cheat Sheet: clojure.org/cheatsheet

ClojureDocs ,由社区驱动的,带代码示例的 API 手册: clojuredocs.org