search

htmlx-org / HTMLx

One Template to rule them all
586 stars 9 forks source link

<doc> tag #13

Closed RedHatter closed 6 years ago

RedHatter commented 6 years ago

What would you think of a <doc></doc> tag? It would be useful for tying documentation in with the component without resorting to big long javascript comment.

arxpoetica commented 6 years ago

Oh. That's a very compelling idea. Could even go a long way towards apps implementing their own methodology of transpiling in-app documentation into—whatever format needed...

maxmilton commented 6 years ago

How would this be more useful than just using comments? Comments come out-of-the-box with all code editors and don't require anything extra. For rich and/or very long documentation I find it better to add a comment with a link to markdown generated docs for example.

arxpoetica commented 6 years ago

Yeah, actually the downfall of <doc> is that then it would have to be officially reserved, so I think @MaxMilton is right. Just comments.