文件中的程式碼片段

在文件中編寫程式碼的規範方法是使用 {@code } 構造。如果你在 <pre></pre> 裡面有多行程式碼包裝。

/**
 * The Class TestUtils.
 * <p>
 * This is an {@code inline("code example")}.
 * <p>
 * You should wrap it in pre tags when writing multiline code.
 * <pre>{@code
 *  Example example1 = new FirstLineExample();
 *  example1.butYouCanHaveMoreThanOneLine();
 * }</pre>
 * <p>
 * Thanks for reading.
 */
class TestUtils {

有時你可能需要在 javadoc 註釋中放入一些複雜的程式碼。@ 標誌特別成問題。在 {@literal } 構造旁邊使用舊的 <code> 標籤解決了這個問題。

/**
 * Usage:
 * <pre><code>
 * class SomethingTest {
 * {@literal @}Rule
 *  public SingleTestRule singleTestRule = new SingleTestRule("test1");
 *
 * {@literal @}Test
 *  public void test1() {
 *      // only this test will be executed
 *  }
 *
 *  ...
 * }
 * </code></pre>
 */
class SingleTestRule implements TestRule { }