如何在 OCaml 中将 let 绑定注释为已弃用？

Question

我想将来自外部库的函数注释为已弃用，以确保它不会在我的项目中使用。假设图书馆提供以下模块：

module Lib : sig
  val safe_function : int -> unit
  val unsafe_function : int -> int -> unit
end = struct
  let safe_function _ = ()
  let unsafe_function _ _ = ()
end

我的项目中有一个 Util.ml 文件，我在每个文件中都打开它。在其中，我想做这样的事情：

open Lib

let unsafe_function = Lib.unsafe_function
  [@@deprecated "Use safe_function instead."]

let foo = (fun x -> x)
  [@@deprecated "BBB"]

type t =
  | A [@deprecated]
  | B [@deprecated]
  [@@deprecated]

正在编译以下 usage.ml 文件

open Util

let _ = unsafe_function 0 0
let _ = foo 0

let _ = A
let f (x : t) = x

产生以下警告：

$ ocamlc -c -w +3 usage.ml
File "usage.ml", line 6, characters 8-9:
Warning 3: deprecated: A
File "usage.ml", line 7, characters 11-12:
Warning 3: deprecated: Util.t

所以 let 绑定上的 deprecated 属性不会触发，但类型定义和构造函数上的属性会触发。 attribute syntax 似乎允许两者。

我找到了，但它似乎已经过时了，因为：

它明确表示“仅适用于值（不适用于类型）”，如上例所示，这是不正确的（现在？）。
文档明确指出注释“可以应用于签名或结构中的大多数项目。”

Answer 1

我不确定确切的语法是什么（你的建议听起来不错并且对应于解析器代码，所以它可能是编译器中的错误），但你可以（ab）使用模块系统来做那：

include (Lib : sig
    val unsafe_function : int -> int -> unit
    [@@ocaml.deprecated "Use safe_function instead."]
  end)

let _ = unsafe_function 0 0 (* warning here *)

如何在 OCaml 中将 let 绑定注释为已弃用？

How to annotate let binding as deprecated in OCaml?

ocaml

annotations

ml

deprecated