Mehrzeiliger Kommentar in Elixir

Question

//, Die meisten Sprachen erlauben Blockkommentare und mehrzeilige Befehle.

Zum Beispiel kann ein mehrzeiliger Kommentar in HTML sieht wie folgt aus:

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

In Elixir, das nächste, was ich gefunden habe, ist wie folgt:

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

EEx Smartengine <% #comments %> scheinen aus der Quelle entfernt werden, auch wenn sie mehrzeilig sind. Dies ist jedoch nur ein Workaround.

Hat Elixir eine mehrzeilige Kommentarfunktion oder eine Möglichkeit, den Compiler anzuweisen, Text aus der kompilierten .beam-Datei zu verwerfen?

Answer 1

Elixir hat keine mehrzeiligen Kommentare. Ein häufiger Anwendungsfall für mehrzeilige Kommentare ist die Dokumentation von Modulen und Funktionen, für die Sie die module attributes @doc and @moduledoc zusammen mit heredocs verwenden können.

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

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

Answer 2

Makros zu einem gewissen Grad helfen, hier könnte:

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

Sie einfach Modul-Attribute für mehrzeilige Kommentare können, kein Makro erforderlich. Ich verwenden in der Regel die folgenden für die Dokumentation/Kommentierung privaten Funktionen:

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

Answer 4

Ich versuche nur „““verwenden, um schnell Code a la Python zu kommentieren, ohne es in eine Dokumentation zu drehen

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