罗伯特·C·马丁的书 Clean Code包含以下内容:
HTML in source code comments is an abomination [...] If comments are going to be extracted by some tool (like Javadoc) to appear in a Web page, then it should be responsibility of that tool, and not the programmer, to adorn the comments with appropriate HTML.
我有点同意 - 如果没有 HTML 标记，源代码肯定会看起来更干净 - 但是你如何制作看起来不错的 Javadoc 页面呢？如果不使用 HTML 标记，甚至无法分隔段落。 Javadoc manual说得很清楚:
A doc comment is written in HTML.
是否有一些预处理器工具可以帮助解决这个问题？ Markdown语法可能是合适的。
最佳答案
我同意。 (这也是我强烈反对 C# 风格的“XML 注释 block ”的原因；Javadoc DSL 至少为顶级实体提供了一些转义!)。为此，我只是不尝试使 javadoc 看起来漂亮...
...无论如何，您可能对 Doxygen 感兴趣。这是一个非常快速的帖子 Doxygen versus Javadoc .它还会提出您所做的问题:-)
关于html - 没有 HTML 的 Javadoc，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/3074789/