Clojure 的命名约定是什么？

Question

任何人都可以解释或指出我在哪里可以找到 clojure 的命名约定：

1. 文件名
2. 函数（据我所知，函数名称只是破折号分隔的值）
3. 变量

Answer 1

您可能需要查看开发人员的 Clojure 库编码标准维基 - 这可能是我见过的最全面的列表。

更新：上面的链接似乎已失效，请考虑：https://clojure .org/dev/contrib_howto#_coding_guidelines

针对您的具体观点：

1. 文件名小写，并存储在目录结构中以匹配命名空间，并以 .clj 结尾，例如“my/special/namespace.clj
2. 函数是用破折号分隔的小写单词，理想情况下是经过描述性选择的，以便您的代码清晰且自记录。不要害怕在不同的命名空间中重复使用好的函数名称（即命名空间的用途是什么！）。
3. 变量（我假设你指的是参数、let 绑定变量等）通常也是用破折号分隔的小写单词，因为代码就是数据，所以我认为这是合适的。函数和数据具有相同的命名约定:-)

Answer 2

您可能需要查看这份非官方风格指南。

Answer 3

有一些有趣的Stuart Sierra 编写的命名指南这表明：

• 纯函数应该是描述返回值的名词（age 而不是 calculate-age）
• 副作用函数应该是描述操作的动词（create- 用于构造，get- 用于检索），保留对可变引用的 bang swap! 更改。
• 也可以是名词的动词应区分为动词短语（send-message 而不是 message）
• 强制转换应命名不带箭头前缀的输出类型（connection< /code> 而不是 ->connection），除非输入类型必须是显式的 (input-type->output-type)
• 命名空间别名可以节省重复（products/price 而不是 products/product-price）并防止 let 绑定
• 函数中的本地冲突，返回函数应具有 -fn 后缀

Answer 4

在评论中记录了一组有趣的命名约定
陶恩索在他的
Encore 库。

他建议使用 ! 来表示副作用，使用 ? 来表示布尔值，
$ 用于昂贵的操作，_ 作为可取消的操作，
* 用于宏；加上一些其他组合。

Answer 5

即使您没有明确要求，我也会解释我所看到的协议命名约定。

通常，名称以大写“I”开头，然后其余部分为驼峰式大小写，其中每个单词的第一个字母大写，其余部分小写。例如，我想为火箭飞船定义一个协议，我会使用名称 IRocketShip

我还看到使用“A”而不是“I”，可能代表“抽象”一词。