文档中的代码片段
在文档中编写代码的规范方法是使用 {@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 { }