[java] 형식화하지 않고 javadoc에서 “<“및 “>”를 어떻게 사용할 수 있습니까?

JAVA / 글쓴이

내가 쓰는 경우 <xmlElement>의 javadoc에 태그 서식 텍스트에 특수 기능을 가지고 있기 때문에, 그것은 표시되지 않습니다.

이 문자를 javadoc에 어떻게 표시 할 수 있습니까?

답변

당신은 사용할 수 있습니다 &lt;에 대한 < 및 &gt;위해 > .

답변

최신 버전의 JavaDoc은 {@literal A <B> C}를 지원합니다. 이렇게하면 콘텐츠가 올바르게 출력됩니다 (생성 된 HTML에서 ‘<‘및 ‘>’이스케이프 처리).

참조 http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html를

답변

XML이 실제 코드라는 점을 고려하면 Javadoc의 XML 스 니펫이 {@literal A <B> C} 태그보다 {@code A <B> C} 태그에 더 적합하다고 생각합니다.

{@code} 태그는 콘텐츠를 실제 코드처럼 돋보이게하는 고정 너비 글꼴을 사용합니다.

답변

HTML로 이스케이프 : &lt;및&gt;

답변

꺾쇠 괄호 중 하나에 해당하는 HTML을 사용해야합니다. 은 <하나 같이 표현 될 수 &lt;또는 &#60;. 다음은 실제 Javadoc에서 가져온 샘플입니다.

<프리>
& lt; complexType>
  & lt; 복잡한 콘텐츠>
    & lt; restriction base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & lt; 시퀀스>
      [...]

다음과 같이 표시됩니다.

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>

답변

markdown을 사용하도록 maven 을 설정 하면 백틱으로 둘러 쌀 수 있습니다.

`A<B>C` 보다 조금 더 읽기 {@code A<B>C}

답변

<pre> 및 {@code}의 삽입은 javadocs에서 꺾쇠 괄호와 빈 줄을 저장하며 널리 사용됩니다. 예를 들어 java.util.Stream을 참조하십시오.

<pre>{@code
   A<B>C

   D<E>F
}</pre>