Comments and Annotations

[jonathanrobie]

Treedown probably needs both:

• Comments: Visible in the Treedown editor, not shown in user-oriented displays.
• Annotations: Like comments, but displayed to the user

For comments, I like to have both comment-to-end-of-line and multiline comments.

I propose that annotations use Jenni Tennison's (: smiley face comment format :).

I propose that comment-to-end-of-line use either # (as in my current files) or //.

I propose that multi-line comments use the ubiquitous /* C-style comments */.

[jtauber]

I think if you're going to support /* */ then the comment-to-end-of-line should be // rather than #.

[jonathanrobie]

Makes sense.

This is an obvious bike-shed issue - we could decide to have only one kind of comments, or two choose any reasonable pair for end-of-line and multiline comments. I suggest we make one decision quickly, and change it if there's a need to later.

[jtauber]

I don't have strong feelings either way