javadoc에서 @ 문자를 어떻게 벗어날 수 있습니까?

180

@javadoc 에서 기호를 이스케이프 처리하려면 어떻게 해야합니까? {@code}태그 안에있는 태그 안에 사용하려고 <pre>합니다.

이미 HTML 이스케이프 @시퀀스를 시도했지만 작동하지 않았습니다.

java escaping javadoc

— JayL
소스

이제 @ {code} 블록 내부의 들여 쓰기를 조정 한 후 잘 표시되기 시작했습니다! 중요한 경우 Eclipse에있었습니다.

— JayL

여전히 작동하지 않습니다

— Neil Benn

267

{@literal}javadoc 태그를 사용하십시오 .

/**
 * This is an "at" symbol: {@literal @}
 */

이에 대한 javadoc은 다음과 같습니다.

This is an "at" symbol: @

물론 이것은 모든 문자에 적용되며 "공식적으로"문자를 표시하는 "공식적으로 지원되는"방법입니다.

당신은 문자의 16 진수 코드를 알 필요가 없습니다 - 그것은 또한 가장 straighforward입니다 그리고 당신은 당신이 입력 한 내용을 읽을 수 있습니다!

— 보헤미안
소스

1

당신은 어떻게 }상징 을 탈출 합니까?

— ADTC

1

@ADTC 당신은 할 수 없습니다. 왜 하시겠습니까? }HTML에서는 특별한 의미가 없습니다.

— 보헤미안

따라서 두 개의 literal태그 로만 나눌 수 있다고 생각합니다 .

— ADTC

23

이것이 받아 들여지고 투표가 된 것에 놀랐습니다. 질문의 전제 : 내부 {@code} 태그 . {@literal}은 {@code} 태그 안에서 작동하지 않습니다.

— Daniel C. Sobral

6

를 생략 {하고 바로 사용 @literal @의 내부 작품 {@code}태그를.

— Brad Turek

55

HTML 엔터티로 작성하십시오.

&#064;

" javadoc-Java API 문서 생성기 " 문서에서

@ 문자로 줄을 시작하고 해석하지 않으려면 HTML 엔터티 @를 사용하십시오.

즉 , 이스케이프해야하는 모든 문자에 HTML 엔터티를 사용할 수 있으며 실제로 다음을 수행 할 수 있습니다.

텍스트는 HTML 엔터티 및 HTML 태그를 사용하여 HTML로 작성해야합니다. 브라우저가 지원하는 HTML 버전을 사용할 수 있습니다. 표준 doclet은 CSS (Cascading Style Sheet) 및 프레임을 포함하여 HTML 주석 호환 코드를 문서 주석 이외의 다른 위치에 생성합니다. 프레임 세트로 인해 생성 된 파일에 HTML 4.0이 선호됩니다.

예를 들어, 심볼보다 적은 (<)에 대한 기업 및 심볼은보다 큰 (>)로 기록되어야 <하고 >. 마찬가지로 앰퍼샌드 (&)는로 작성해야합니다 &.

— 프랭크 V
소스

공백이없는 경우 (예 : 주석을 작성할 때) 리터럴 표현식보다 효과적입니다.

— Bludwarf

8

내 해결책은

/**
 * Mapper Test Helper.
 *
 * add the following annotations above the class
 * <pre>{@code
 * // junit5
 * @literal @ExtendWith(SpringExtension.class)
 * // junit4
 * @literal @RunWith(SpringRunner.class)
 * }</pre>
 */

— 김영준
소스

2

일반적인 아이디어를 얻었습니다. 8 진 표현을 사용해보십시오. @

— 유발 아담
소스

6

이것은 8 진이 아닙니다.

— Joey

@16 진수 코드 포인트 0x40, 10 진수 64 (64

— Binkan Salaryman