comment annotation examples

[christopheradams]

comment annotation examples

[christopheradams]

Which comment annotations are most in need of examples?

[nhooyr]

An example for the third point would be nice. https://github.com/christopheradams/elixir_style_guide#multiple-line-annotations

It would automatically cover the previous two.

something like

# TODO: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam nunc ex, fringilla
#  rhoncus arcu sed, venenatis luctus mi.
def some_func do
end

And for point 4, should a colon still be included or just #ANNOTATION?

[christopheradams]

Are any big Elixir libraries even following this rule? This might be a good opportunity to review this section.

[christopheradams]

And for point 4, should a colon still be included or just #ANNOTATION?

Yes, a colon should be used after the comment ANNOTATION. This is the preferred style. It should also be uppercase, which is not currently mentioned.

The multiple-line-annotations rule (two-space indent for subsequent comment lines) is not followed in the Elixir community as far as I can tell, so that rule can be dropped.

[christopheradams]

@nhooyr Please check PR #134, and let me know if the comment examples are sufficient, or if you think we should add anything.