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

120

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

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

java javadoc

— 톰 브리토
소스

4

관련이 있지만 속이는 것은 아닙니다 : stackoverflow.com/questions/1782040/…

— Pops

160

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

— 파 비타 싱
소스

또는 & amp; 탈출하기 위해 &

— ILMTitan

14

@TomBrito 이것이 실제 질문에 대한 답이기는하지만 기호를 이스케이프해야하는 필요성은 꺾쇠 괄호 (즉, 쌍으로)로 사용되는 경우에만 나타납니다. 즉, XML 태그와 같은 일부 코드의 일부임을 의미합니다. OP의 경우와 같이). 이 상황에서 {@code ...}Etienne Delavennat가 그의 답변에서 제안한 것처럼 전체 XML 조각을 태그 로 감싸는 것이 더 나은 해결책이라고 생각합니다 .

— Zoltán 2015 년

&gt또는 &ltXML 형식의 꺾쇠 괄호와 정확히 같은 의미가 아닙니다. 그러나 {@code <>}올바른 선택입니다.

— cinqS

63

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

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

— 하워드 M. 루이스 선박
소스

41

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

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

— 에티엔 델라 베나 트
소스

2

나는 동의한다. XML은 {@code }태그 로 감싸 야 합니다. 고정 너비 글꼴로 더 자연스럽게 표시되고 꺾쇠 괄호를 별도로 이스케이프 할 필요가 없기 때문에 소스 javadoc에서는 이상하게 보이지 않습니다.

— Zoltán 2015 년

15

HTML로 이스케이프 : <및>

— 더 피모
소스

9

꺾쇠 괄호 중 하나에 해당하는 HTML을 사용해야합니다. 은 <하나 같이 표현 될 수 <또는 <. 다음은 실제 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>

— 아저씨
소스

3

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

`AC` 보다 조금 더 읽기 {@code AC}

— 오웬
소스

2

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

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— 세르 그
소스

1

다음과 {@code}같이 둘러싸십시오 .

{@code <xmlElement>}

— 이반 제르 마코프
소스