3 ms·
> you have to choose between "readable in my text editor" and "readable in the compiled form" Not sure what you mean by that. You mostly get by with a <p> betw
by layer8 4y ago
> you have to choose between "readable in my text editor" and "readable in the compiled form"
Not sure what you mean by that. You mostly get by with a <p> between paragraphs and the occasional <ul><li> or <pre>. And you’ll have the {@…} tags in any case. IDEs usually highlight HTML tags within javadoc differently, which helps readability.
The one thing that is indeed annoying is the </>/&.
- avgcorrection 4y ago> 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…
- layer8 4y agoIt’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.
- avgcorrection 4y agoI’ll give you that. For the people who are writing documentation IN XML OR JSON it’s bound to be a big step up.