我是 Elixir 的新手,我想知道是否可以使用 ExDoc 记录 API 路由? 路由器包含在文档中,但不包含在路由中(因为它们不是函数)。 例如,这是一个示例代码: 我可以记录这是ExDoc吗?如果是,如何记录? 对不起,如果我错过了一些明显的东西! ...
我是 Elixir 的新手,我想知道是否可以使用 ExDoc 记录 API 路由? 路由器包含在文档中,但不包含在路由中(因为它们不是函数)。 例如,这是一个示例代码: 我可以记录这是ExDoc吗?如果是,如何记录? 对不起,如果我错过了一些明显的东西! ...
我正在尝试使用 ExDoc 为我的 Elixir 项目中的应用程序生成文档。 我的项目结构为一个伞形应用程序,有两个应用程序,一个功能核心和一个 Phoenix web 前端。 从伞的根目录运行命令mix docs时,我收到以下错误消息: 根 mix.exs 文件如下: 我应该在project/1 ...
我正在用ex_doc编写文档,这看起来非常不错,但是我遇到了问题。 当一个函数具有一个映射作为参数时,它在文档中被写为“映射”。 我想将其显示为“参数”。 例 def login(conn, %{"email" => email, "password" => passwo ...
我有一个简单的宏,可以将函数注入到调用模块中。 这可以按预期工作,但是由于run函数嵌套在quote块内,因此我无法使用ExDoc添加文档。 我还想在外部定义run函数,因为我认为这会使代码看起来更好。 像这样: 我该怎么做呢? 另外,如何使用ExDoc为嵌套函数添加文档? ...
我最近创建了我的第一个Hex包; Ecto.Rut和我现在正在研究它的文档。 由于它在后面使用Ecto.Repo并返回Ecto.Schema和Ecto.Changeset类型,我想在@specs中链接它们。 内部和Elixir核心类型(如Keyword.t )会自动链接,但ex_doc ...