Comment by zylepe

Comment by zylepe 3 days ago

3 replies

I haven’t used markdown in javadoc yet but this seems like at least 3/10? I often want to put paragraphs or bulleted lists in javadoc and find myself wanting to use markdown syntax for readability in the code but need to switch to less readable html tags for tooling to render it properly.

MBCook 3 days ago

Personally it’s fine, I haven’t used it though.

I really wish Javadoc was just plain text that honored line breaks. I really don’t care about the fact I can put HTML in there, that just seems dumb to me. I get you can’t remove it but I would be happy if you could.

I do like markdown. But I don’t see myself ever using it in a Javadoc.

ronyeh 3 days ago

I hate using html in comments.

Markdown in javadoc is at least 7/10 for me. Improves comment readability for humans while allowing formatted javadocs.

  • metaltyphoon 2 days ago

    I wish C# would add this too. I despise having to write docs in XML style