Support HTML comments

[whisk]

Problem

Yes, you can render comments as Text nodes:

content := Text("<!-- this is a comment -->").Render()

But it's too verbose and error prone (could easily mix up opening/closing comment quotes)

Possible solution

Add Comment element:

content := Comment("this is a comment").Render()

Pros: intuitive
Cons:

• it is not a real HTML element or a tag
• can't use this for inside tag comments (but does anyone need that actually?)

As far as I know, many programming language parsers consider comments as properties of "real" nodes, not as separate nodes. But that seems too complex both to use and implement.

[chasefleming]

@whisk great feature idea! Thanks for adding this. I like solution and I think it follows the existing patterns nicely. It's ok that it's not a real HTML element. I just implemented something similar for CSS: https://github.com/chasefleming/elem-go/blob/main/styles/styles.go#L38

I think Comment as a function that returns a CommentNode with a RenderTo and Render method to satisfy the Node interface just like Text and TextNode or CSS and CSSNode is the right solution.

Did you want to take this on as well or just posting the issue?

[whisk]

Hi @chasefleming, please check this PR #71 :)