3 ms·
Yes!!! Yay! I am so overjoyed. I have been actively wanting this feature over half a decade. Over the same time, my javadocs are already written in markdown wi
by seadan83 2y ago
Yes!!! Yay! I am so overjoyed.
I have been actively wanting this feature over half a decade. Over the same time, my javadocs are already written in markdown with sparse html smuggled in as strictly needed.
For example, instead of:
```
<p>Accepts these inputs:<br>
<ul>
<li>phone numbers</li>
<li>zip codes</li>
</ul>
```
I have been writing:
```
Accepts these inputs: <br>
- phone numbers <br>
- zip codes <br>
```
My spiel is super well rehearsed to discuss why most projects should not write their javadocs in full html. Every project I have worked on over 2 decades has never actually rendered javadocs to the standalone HTML pages. Those projects are (i believe) the exception, things like library code. Thus, most developers read the documentation in the source code, not as rendered html. Caveat: Yes, some IDEs will render the html javadocs inline in source. I do think that has been a useful crutch. But, why force a developer the extra burden of writing html if nobody wants to read html?
Three cheers for markdown!! <3