====== javadoc ======

===== inherit =====
<code java>
/**
 * {@inheritDoc}
 * <p/>
 * 기타 추가 내용..
 */
public String someMethod(String arg) {
    // ...
}
</code>

interface 구현체 메소드에서 ''{@inheritDoc}''을 사용하면 인터페이스에 있는 javadoc이 복사되어 생성된다. 내용을 더 추가하는 것도 가능하다.

===== code block =====
  * ''<pre></pre>'' 만 하면 기본 monospace 글꼴로 된다. 코드 컬러로 보여주는 역할까지 하려면

<code>
<pre>{@code
원하는 코드 작성
}</pre>
</code>

===== Literal =====
''@'' 같은 특수한 문자는 ''@literal''로 Escape한다.
''@Rule''을 표현하고자 한다면,
<code>
{@literal @}Rule
</code>
하지만 해보면 HTML entity ''&#064;'' 가 더 좋은듯.
<code>
&#064;Rule
</code>

===== @inheritDoc =====
  * ''{@inheritDoc}'' : inline
  * 인터페이스나 수퍼 클래스의 메소드의 문서를 상속받는다. 상위 클래스의 문서를 반복할 필요가 없다.
  * method 레벨만 적용된다.
  * [[https://www.baeldung.com/javadoc-see-vs-link|Javadoc: @see, @link, and @inheritDoc | Baeldung]]

===== doclets =====
  * [[springframework:springdoclet|Doclets for Springframework]]
  * [[https://docs.oracle.com/javase/6/docs/technotes/guides/javadoc/doclet/overview.html|Doclet Overview]]
  * [[https://github.com/Abnaxos/markdown-doclet|Markdown Doclet]] Markdown 기반 Javadoc
  * [[https://github.com/asciidoctor/asciidoclet|Asciidoclet]] Asciidoc 기반 Javadoc
  * [[https://dzone.com/articles/extracting-javadoc-documentation-from-source-files|Extracting Javadoc Documentation From Source Files Using JavaParser - DZone Java]]
  * https://javaparser.org
  * [[https://tomassetti.me/extracting-javadoc-documentation-source-files-using-javaparser/|Extracting JavaDoc documentation from source files using JavaParser - Strumenta]]