포맷하지 않고 자바독에서 "<"와 ">"를 사용하려면 어떻게 해야 합니까?
내가 글을 쓴다면<xmlElement>
javadoc에서는 태그가 텍스트 서식을 지정하는 특수 기능을 가지고 있기 때문에 표시되지 않습니다.
자바독에서 이 문자를 표시하려면 어떻게 해야 하나요?
사용할 수 있습니다.<
<및>
를 누릅니다.
JavaDoc의 최신 버전은 {@literal A<B>C}를 지원합니다.이것에 의해, 컨텐츠가 올바르게 출력됩니다(생성된 HTML 의 「<」및 「>」의 이스케이프).
http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html 를 참조해 주세요.
XML이 실제 코드임을 고려하면 자바독의 XML 스니펫은 {@literal A<B>C} 태그보다 {@code A<B>C} 태그에 적합합니다.
{@code} 태그는 고정 너비 글꼴을 사용하여 해당 콘텐츠를 실제 코드로 두드러지게 만듭니다.
HTML로 이스케이프:<
그리고.>
각 괄호 중 하나에 해당하는 HTML만 사용하면 됩니다.그<
둘 중 하나로 나타낼 수 있다<
또는<
다음은 실제 Javadoc에서 가져온 샘플입니다.
<프리><complex Type><복잡한 내용><contion base="{http://www.w3.org/2001/XMLSchema}anyType"><시퀀스>[...]
다음과 같이 표시됩니다.
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
<pre>와 {@code}를 삽입하면 꺽쇠 괄호와 빈 줄이 javadocs에 저장되며 널리 사용됩니다(java.util 참조).예를 들어 스트림입니다.
<pre>{@code
A<B>C
D<E>F
}</pre>
에워싸기만 하면 돼{@code}
다음과 같습니다.
{@code <xmlElement>}
마크다운을 사용하도록 메이븐을 설정하면 백틱으로 둘러싸면 됩니다.
`A<B>C`
보다 조금 더 좋게 읽는다{@code A<B>C}
내 경우엔 자바독을 넣고 싶었지만List<SomeClass>
...
링크를 통해 보다 구체적인 정보를 추가했습니다.SomeClass
그래서 제 해결책은 다음과 같습니다.
List<{@link SomeClass}>
그 결과, 다음과 같이 깨끗해졌습니다.
List<SomeClass>
밑줄 친 'SomeClass'가 지정된 클래스로 이동합니다.
(물론 만약SomeClass
같은 패키지에 포함되어 있지 않습니다.완전한 경로를 참조해 주세요.
언급URL : https://stackoverflow.com/questions/2898897/how-can-i-use-and-in-javadoc-without-formatting
'programing' 카테고리의 다른 글
공변량 반환 유형이란 무엇입니까? (0) | 2022.09.03 |
---|---|
Kotlin의 클래스와 객체의 차이 (0) | 2022.09.03 |
짧은 값 Java 설정 (0) | 2022.09.03 |
개조를 사용하여 GSON을 사용하여 중첩된 JSON 개체 가져오기 (0) | 2022.09.03 |
클래스의 개개의 에넘을 자바독하는 방법 (0) | 2022.09.03 |