OCaml 中的注释

Question

标题可能有点误导，所以让我解释一下我想要实现的目标。

我正在编写一种编程语言，它有大量的运算符，可以处理具有不同行为的多种类型。实施正在不断发展，操作员正在改变/适应我在尝试时发现更有用的东西。

问题是如何保持语言文档、实现和语言的内联帮助（具有某种 REPL）之间的一致性。

由于大多数行为是在大模式匹配块内定义的，我想知道是否可以以某种方式（也许使用 Camlp4）对代码进行注释，以便预处理运行可以提取列出的 txt 文件（或任何类似的 csv、html 等）所有运营商都实施了。

我的意思是，如果我有类似的东西

match instruction with
  Plus -> ...
  | Minus -> ...

，我希望

match instruction with
  (* Plus, +, int -> int -> int, computes the sum *)
  Plus -> ...
  (* Minus, -, int -> int -> int, computes the difference *)
  | Minus -> ...

在注释中包含类似的信息（我使用注释语法只是为了使用某些东西，我真的从未使用过 OCaml 预处理器，所以我不知道它是如何工作的）在我编译项目时被提取并保存在某处。

也许所要求的是不可能的，我必须使用与 ocaml 预处理器/编译器本身不同的东西单独处理源代码。

有什么线索吗？

编辑：我将给出一个具体的例子来展示我想要做什么...

例如，加号指令以这种方式编译用我的语言编写的程序：

| Plus -> (fun s ->
        let o2 = vm_pop s and o1 = vm_pop s in
          (match o1, o2 with
              Float f1, Float f2 -> vm_push s (Float (f1 +. f2))
            | Float f, Int i -> vm_push s (Float (f +. float i))
            | Int i, Float f -> vm_push s (Float (float i +. f))
            | Int i1, Int i2 -> vm_push s (Int (i1 + i2))
            | Complex c1, Complex c2 -> vm_push s (Complex (Complex.add c1 c2))
            | String str, v -> vm_push s (String (Printf.sprintf "%s%s" str (string_value_short v)))
            | List l, a -> l := a :: !l; vm_push s (Types.I.List l)
            | (Set c as set), a -> c := Types.ValueSet.add a !c; vm_push s set;
            | w, w2 -> throw_exc2 "+" w w2
          ); s
      )

我希望能够注释此模式匹配的每个子句通过某种

(* Plus, +, float -> float -> float, sum, computes the sum between two floats *)
(* Plus, +, string -> any -> string, append, appends the string representation of the value *)
(* etc *)

方式，我能够预处理我的源代码并构建所有已实现操作及其类型和描述的列表，这些操作仅从注释中获取。我不需要修改我的代码中的任何内容。这只是为了在一个地方保持一致性，而不必以单独的方式跟踪所有可用的指令（因为我也需要为文档和内联帮助对它们进行索引）。

我想在不使用任何外部处理工具的情况下完成此操作，这就是为什么我询问是否有一些东西能够在编译阶段处理注释或类似的东西。

提前致谢

Answer 1

您看过 ocamldoc 吗？

不过，通常情况下，更多的是 .mli 文件接收注释。在您的情况下，您介意在类型 instruction 的定义处编写文档吗？喜欢：

(** Comment for type weather  *)
type weather =
| Rain of int (** The comment for construtor Rain *)
| Sun (** The comment for constructor Sun *)

Answer 2

你想要做的事情听起来很像文学编程，所以我建议 ocamlweb，即使它是外部工具。

在标准发行版中，有 ocamldoc，如
Pascal 建议，但您对源语法或内容没有太多控制权输出看起来像。

使用 CamlP4（标准 Ocaml 预处理器），您可以更改词法分析器以访问注释，但我认为这并不容易。向包含字符串或带有字符串扩展器的引号的模式语法添加条目要容易得多，因此您可以编写类似 | 的内容。 <:casedoc<加号、+、int ->整数-> int，计算总和>>加号-> ...。