如何在Elixir中禁用类型定义的文档生成?
如何在Elixir中隐藏内部类型的文档?
嘿,这个场景太常见了!要让你这个内部用的bar类型不被生成到文档里,只需要给它加上@doc false注解就行,非常简单。
修改后的代码应该是这样的:
defmodule Foo do @doc false @type bar :: String.t() end
解释一下:@doc false会告诉ExDoc(Elixir默认的文档生成工具)跳过这个类型的文档生成,完美符合你把它作为内部实现细节隐藏起来的需求。
另外补充个小知识点:这个方法不止适用于类型,如果你有内部函数、宏之类的不想对外暴露文档,同样可以在它们的定义前加上@doc false(要是整个模块都不想生成文档,还能用@moduledoc false,不过你这里只是单个类型,用@doc false就足够了)。
内容的提问来源于stack exchange,提问作者Tony Han
相关产品推荐
相关产品推荐

