On Markdown in Java documentation comments

Re:On Markdown in Java documentation comments by avgcorrection on Tuesday January 24, 2023 @06:08PM (#34511949)

> You mostly get by with a <p> between paragraphs and the occasional <ul><li> or <pre>.

That’s very noisy when the equivalent MD is so lightweight (hyphen for bullet points is as lightweight as it gets).

> And you’ll have the {@…} tags in any case. IDEs usually highlight HTML tags within javadoc differently, which helps readability.

The Java response to anything: Well with an IDE…

[ Parent | on HN ]

Re:On Markdown in Java documentation comments by layer8 on Tuesday January 24, 2023 @08:26PM (#34513137)

It’s not very noisy compared to full-blown XML or JSON. Certainly not unreadable like the parent claimed.

About IDEs, yeah, Java is certainly an IDE language, no sensible way around that.

[ Parent | on HN ]

Re:On Markdown in Java documentation comments by avgcorrection on Wednesday January 25, 2023 @03:15PM (#34523546)

I’ll give you that. For the people who are writing documentation IN XML OR JSON it’s bound to be a big step up.

[ Parent | on HN ]