Java Language Extraits de code dans la documentation


Exemple

La manière canonique d'écrire du code dans la documentation est la construction {@code } . Si vous avez du code multiligne, retournez-le dans <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 {

Parfois, vous devrez peut-être mettre du code complexe dans le commentaire javadoc. Le signe @ est particulièrement problématique. L'utilisation de l'ancienne <code> côté de la construction {@literal } résout le problème.

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