Looking for java Keywords? Try Ask4Keywords

Java Language Фрагменты кода внутри документации


пример

Канонический способ написания кода внутри документации - с конструкцией {@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. Знак @ является особенно проблематичным. Использование старого <code> рядом с конструкцией {@literal } решает проблему.

/**
 * 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 { }