Jak mogę uciec od @
symbolu w javadoc? Próbuję użyć go w {@code}
tagu, który jest w środku<pre>
tagach.
Próbowałem już @
sekwencji ucieczki HTML , ale to nie działało.
Jak mogę uciec od @
symbolu w javadoc? Próbuję użyć go w {@code}
tagu, który jest w środku<pre>
tagach.
Próbowałem już @
sekwencji ucieczki HTML , ale to nie działało.
Odpowiedzi:
Użyj {@literal}
tagu javadoc:
/**
* This is an "at" symbol: {@literal @}
*/
Jawadok w tym celu będzie czytał:
This is an "at" symbol: @
Oczywiście będzie to działać dla dowolnych postaci i jest to „oficjalnie obsługiwany” sposób wyświetlania dowolnych „znaków specjalnych”.
Jest to również najprostsze - nie musisz znać kodu szesnastkowego znaku i możesz przeczytać, co wpisałeś!
}
symbolu?
}
nie ma specjalnego znaczenia w html.
literal
tagi.
{
i użycie @literal @
działa wewnątrz {@code}
tagu.
Po prostu napisz jako encję HTML:
@
Z dokumentu „ javadoc - The Java API Documentation Generator ”
Jeśli chcesz rozpocząć wiersz ze znakiem @ i nie interpretować go, użyj encji HTML @.
Oznacza to, że możesz używać encji HTML dla każdego znaku, którego potrzebujesz, aby uciec, i rzeczywiście możesz:
Tekst musi być napisany w języku HTML z elementami HTML i znacznikami HTML. Możesz użyć dowolnej wersji HTML obsługiwanej przez przeglądarkę. Standardowy doclet generuje kod zgodny z HTML 3.2 gdzie indziej (poza komentarzami do dokumentacji) z włączeniem kaskadowych arkuszy stylów i ramek. HTML 4.0 jest preferowany dla generowanych plików ze względu na zestawy ramek.
Na przykład jednostki dla symbolu mniejszego niż (<) i większego niż symbol (>) należy zapisać jako
<
i>
. Podobnie, ampersand (&) należy zapisać jako&
.
moim rozwiązaniem jest
/**
* Mapper Test Helper.
*
* add the following annotations above the class
* <pre>{@code
* // junit5
* @literal @ExtendWith(SpringExtension.class)
* // junit4
* @literal @RunWith(SpringRunner.class)
* }</pre>
*/
Masz ogólny pomysł, spróbuj użyć ósemkowej reprezentacji: @
@
ma