IntelliJ IDEA - 在Java文档注释中呈现HTML标记

时间:2013-07-20 04:42:30

标签: java intellij-idea documentation comments markup

有没有办法在IntelliJ IDEA的文档注释中临时呈现HTML标记?我希望能够这样做,因为它使阅读一些文档更容易。例如,请考虑jUnit源代码中的以下代码段:

/**
 * The <code>Test</code> annotation tells JUnit that the <code>public void</code> method
 * ...
 * ...
 * <p>
 * A simple test looks like this:
 * <pre>
 * public class Example {
 *    <b>&#064;Test</b>
 *    public void method() {
 *       org.junit.Assert.assertTrue( new ArrayList().isEmpty() );
 *    }
 * }
 * </pre>
 * <p>
 * The <code>Test</code> annotation supports two optional parameters.
 * The first, <code>expected</code>, declares that a test method should throw
 * ...
 * ...
 * <pre>
 *    &#064;Test(<b>expected=IndexOutOfBoundsException.class</b>) public void outOfBounds() {
 *       new ArrayList&lt;Object&gt;().get(1);
 *    }
 * </pre></p>
 * <p>
 * The second optional parameter, <code>timeout</code>, causes a test to fail if it takes
 * longer than a specified amount of clock time (measured in milliseconds). The following test    fails:
 * <pre>
 *    &#064;Test(<b>timeout=100</b>) public void infinity() {
 *       while(true);
 *    }
 * </pre>
 * <b>Warning</b>: while <code>timeout</code> is useful to catch and terminate
 * infinite loops, it should <em>not</em> be considered deterministic. The
 * ...
 * ...
 * <pre>
 *    &#064;Test(<b>timeout=100</b>) public void sleep100() {
 *       Thread.sleep(100);
 *    }
 * </pre>
 *
 *
 * @since 4.0
 */

所有标记,更不用说HTML编码,使解析文档变得有点困难。

我试图找到一种方法来做到这一点,但没有任何有意义的事情发生了。也许我没有使用正确的关键字?

1 个答案:

答案 0 :(得分:1)

您可以使用快速文档(Ctrl-Q / menu - &gt; view - &gt;快速文档),无论您在评论本身(或插入符号的代码中的某个位置)(表示插入符号) - 例如

中的测试
@Test
public void myTest() throws Exception