programing

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

bestcode 2022. 8. 19. 20:50
반응형

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

어떻게 하면 탈출할 수 있을까?@javadoc 기호?실내에서 사용하려고 합니다.{@code}태그(내부)<pre>태그를 지정합니다.

나는 이미 html 이스케이프를 시도했다.&#64;하지만 효과가 없었어요

javadoc 태그를 사용합니다.

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

이를 위한 javadoc은 다음과 같습니다.

This is an "at" symbol: @

물론 이는 모든 문자에 적용되며 "특수" 문자를 표시하는 "공식 지원" 방식입니다.

이것은 또한 가장 직설적이다 - 당신은 문자의 16진수 코드를 알 필요가 없으며, 당신이 입력한 것을 읽을 수 있다!

HTML 엔티티로 쓰면 됩니다.

&#064;

문서 "javadoc - Java API Documentation Generator"에서

행을 @ 문자로 시작하고 해석하지 않을 경우 HTML 엔티티 @ 를 사용합니다.

즉, 이스케이프가 필요한 모든 문자에 HTML 엔티티를 사용할 수 있으며 실제로 다음과 같은 작업을 수행할 수 있습니다.

텍스트는 HTML 엔티티와 HTML 태그를 사용하여 HTML로 작성해야 합니다.브라우저에서 지원하는 HTML 버전을 사용할 수 있습니다.표준 doclet은 캐스케이드 스타일시트 및 프레임을 포함한 HTML 3.2 준거 코드를 다른 곳(문서 주석 외)에 생성합니다.생성된 파일에는 프레임세트가 있기 때문에 HTML 4.0이 적합합니다.

예를 들어 less than 기호(<) 및 greater than 기호(>)의 엔티티는 다음과 같이 기술해야 합니다.&lt;그리고.&gt;마찬가지로 앰퍼샌드(&)는 다음과 같이 표기해야 합니다.&amp;.

나의 해결책은

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

대충 이해하셨으니 8진수 표현을 사용해 보세요.&#064;

15.0.2 이후 javadoc 툴로 수정

15.0.2에서 javadoc 도구를 사용하면 이 문제가 해결된 것으로 보입니다.

즉, javadoc multiline을 사용할 때 @ 문자를 피할 필요가 없습니다.{@code ... }차단합니다.

JDK 버그가 기록되어 있다.https://bugs.openjdk.java.net/browse/JDK-8130754 ...이 파일은 현재 고정되어 있지 않지만 javadoc 15.0.2에서 재생되지 않습니다.

언급URL : https://stackoverflow.com/questions/2290757/how-can-you-escape-the-character-in-javadoc

반응형