在 IntelliJ IDEA 的内联 Javadoc 中检查尖括号的使用情况（不在标签中）

Question

非常简单的问题：我经常忘记在 Javadoc doesn't work without using the either a literal block or </> 中使用小于号和大于号，因为它们被视为格式标记。这随后导致我的 Jitpack 构建失败。我使用 IntelliJ IDEA 作为我的主要 Java IDE，当我在 JavaDoc 中使用尖括号时，它似乎没有给出任何警告； 有没有办法检查这些符号的不当使用？

Answer 1

According to Serge Baranov from JetBrain's support team:

It's a known limitation, please vote for https://youtrack.jetbrains.com/v2/issue/IDEA-165488.

问题的描述符合预期：

Idea's 'HTML problems in Javadoc (DocLint)' does not report any problems in the following javadoc:
/**
 * a < b > c
 */
void test();
However, javadoc generation will fail in this case:
Test.java:5: error: malformed HTML
     * a < b > c
         ^
Test.java:5: error: bad use of '>'
     * a < b > c
             ^
Usually this problem is noticed only at the javadoc generation phase of Maven build process and that's rather inconvenient.

Also, it would be great to have an intention to escape such symbols in javadoc as &gt / &lt.

但是，截至发帖时，该错误没有特别的优先级、花费的时间或验证（尽管它已被分类）。Developer/SO 用户 Roman Shevchenko 似乎已分配给该问题.考虑到这不是一个大问题，我不希望特别快地修复。

在 IntelliJ IDEA 的内联 Javadoc 中检查尖括号的使用情况（不在标签中）

Check for improper angle bracket usage (not in tags) in inline Javadoc in IntelliJ IDEA

java

tags

javadoc

intellij-idea