elixir-lang/elixir — Issue #144: Reduce the hassle with documentation
Author: josevalim
Created: 2012-03-05 13:52:24+00:00
State: open
Labels: Bug

Currently, documentation is done via:

@doc """
HEREDOC
"""

There is a problem with this approach, it accepts string interpolations and escape characters, which makes the documentation sometimes unnecessarily harder to write. One possible suggestion is that, after we introduce string modifiers, we could mix heredocs with such modifiers:

@doc %E"""
HEREDOC
"""

Or:

@doc """E
HEREDOC
"""

I have not picked up a syntax yet, but regardless, I am afraid it will be too much noise. I am open to suggestions and recommendations from other programming languages.

/cc @fxn