Elixir的多行评论

Question

大多数语言都允许块注释和多行命令.

例如,HTML中的多行注释如下所示:

<!-- 
Warning, brave programmer:
Here be dragons.
-->

在Elixir中,我发现的最接近的事情如下:

http://elixir-lang.org/docs/v1.0/eex/

EEx smartengine <% #comments %>似乎从源头被丢弃,即使它们是多线的.但是,这只是一种解决方法.

Elixir是否具有多行注释功能,或指示编译器从已编译的.beam文件中丢弃文本的方法？

Answer 1

Elixir没有多行评论.

然而,一个非常普遍的使用情况多意见是记录模块和功能,以便您可以使用该模块的属性@doc,并@moduledoc连同here文档.

defmodule MyModule do
  @moduledoc """
  This module is great at X
  """

  @doc """
  Frobnicates the given string.
  """
  def frobnicate(s) do
  end
end

Answer 2

宏可以在某种程度上帮助:

defmodule Comment do
  defmacro comment(_text) do
  end
end

defmodule TestComment do
  import Comment

  comment """
  Module
  Comment
  """

  def func do
    comment """
    Function
    Comment
    """
  end
end

Answer 3

我试着用""来快速评论Python代码,而不是把它变成文档

"""
def some_function() do
  some_code    
end
"""

Answer 4

您可以简单地将模块属性用于多行注释，而无需宏。我通常使用以下内容来记录/注释私有功能：

@docp """
This is my
multi line
comment
"""