4 ms·
The worst thing about HTML as docs is that you have to encode your code. You should just be able to write the code for the programming language you are using di
by avgcorrection 3y ago
The worst thing about HTML as docs is that you have to encode your code. You should just be able to write the code for the programming language you are using directly in the docs. Anything else is just nuts.
- pron 3y agoWell, you do need things like emphasis, lists, headings etc., which aren't typically part of a programming language.
- avgcorrection 3y agoWhat do you mean? I’m talking about Java code inside javadoc, like code example docs.[1] That’s straightforward if the doc markup is MarkDown with code fences. The MarkDown code character backtick is especially great for Java since it’s not a metacharacter in the Java syntax. [1] I didn’t mean writing docs in Java itself, whatever that would look like.
- pron 3y agoOh, ok. Yeah, that's supported, but it's also supported today without HTML with the snippet tag (and @code tag).
- avgcorrection 3y agoOkay great. Thanks Ron :)