如何在Elixir中禁用doc生成类型定义？

Question

例如我有一个类似

的模块

defmodule Foo do
  @type bar :: string
end

但我不想为bar生成文档，因为它意味着使用内部实现。

Answer 1

@typedoc类型的函数有@doc，但与@doc false不同，@typedoc false似乎不会隐藏文档中的类型。由于这是供内部使用的，我假设您不想将其导出模块，因此您可以使用@typep将其声明为私有，这也将从文档中删除它：

defmodule Foo do
  @typep bar :: string
end

Answer 2

我相信你可以使用旗帜

  Accounts <- c('A','B','C','D',
                'A','B','C','D',
                'A','B','C','D')
  Dates <- as.Date(c('2016-01-31', '2016-01-31','2016-01-31','2016-01-31',
                     '2016-02-28','2016-02-28','2016-02-28','2016-02-28',
                     '2016-03-31','2016-03-31','2016-03-31','2016-03-31'))
  Balances <- c(100,NA,NA,NA,
                90,50,10,NA,
                80,40,5,120)
  Origination <- data.frame(Dates,Accounts,Balances)

在您不想要文档的代码之上。 如文档中所示：