comments - Comentario multilínea en elixir

multiline

Question

//, la mayoría de los idiomas permiten comentarios en bloque y comandos multilínea.

Por ejemplo, un comentario multilínea en HTML se parece a lo siguiente:

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

En Elixir, lo más cercano que he encontrado es el siguiente:

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

EEx smartengine <% #comments %> parece que se descartan de la fuente, incluso si son multilínea. Sin embargo, esto es sólo una solución.

¿Tiene Elixir una función de comentarios de varias líneas o una forma de indicar al compilador que descarte el texto del archivo .beam compilado?

Answer 1

Elixir no tiene comentarios multilínea.

Sin embargo, un caso de uso muy común para comentarios multilínea es documentar módulos y funciones, para los cuales puede usar los atributos de módulo @doc y @moduledoc junto con heredocs .

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

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

Answer 2

Intento simplemente usar "" "para comentar rápidamente el código a la Python, sin convertirlo en una documentación

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

Answer 3

Las macros podrían ayudar aquí hasta cierto punto:

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 4

Simplemente puede usar los atributos del módulo para comentarios de varias líneas, no se requiere macro. Normalmente uso lo siguiente para documentar / comentar funciones privadas:

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