Làm thế nào bạn có thể thoát khỏi ký tự @ trong javadoc?

180

Làm thế nào tôi có thể thoát khỏi @biểu tượng trong javadoc? Tôi đang cố gắng sử dụng nó bên trong một {@code}thẻ, bên trong <pre>các thẻ.

Tôi đã thử @chuỗi thoát html , nhưng nó không hoạt động.

java escaping javadoc

— JayL
nguồn

Bây giờ nó đã bắt đầu hiển thị tốt sau khi tôi điều chỉnh một số vết lõm bên trong khối @ {code}! Đây là trong Eclipse nếu nó quan trọng.

— JayL

Tôi vẫn không thể làm cho nó hoạt động được

— Neil Benn

267

Sử dụng {@literal}thẻ javadoc:

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

Các javadoc cho điều này sẽ đọc:

This is an "at" symbol: @

Tất nhiên, điều này sẽ hoạt động cho bất kỳ ký tự nào và là cách "được hỗ trợ chính thức" để hiển thị bất kỳ ký tự "đặc biệt" nào.

Đây cũng là điều khó khăn nhất - bạn không cần biết mã hex của ký tự và bạn có thể đọc những gì bạn đã nhập!

— Bohemian
nguồn

1

Làm thế nào để bạn thoát khỏi }biểu tượng?

— ADTC

1

@ADTC Bạn không thể. Tại sao bạn sẽ muốn? }không có ý nghĩa đặc biệt trong html.

— Bohemian

Vì vậy, tôi đoán bạn chỉ có thể chia nó thành hai literalthẻ.

— ADTC

23

Tôi ngạc nhiên khi điều này được chấp nhận và được bình chọn. Tiền đề của câu hỏi: bên trong thẻ {@code} . {@literal} chỉ không hoạt động trong thẻ {@code}.

— Daniel C. Sobral

6

Bỏ qua {và chỉ sử dụng @literal @các tác phẩm bên trong {@code}thẻ.

— Brad Turek

55

Chỉ cần viết nó dưới dạng thực thể HTML:

&#064;

Từ tài liệu " javadoc - Trình tạo tài liệu API Java "

Nếu bạn muốn bắt đầu một dòng với ký tự @ và không được giải thích, hãy sử dụng thực thể HTML @.

Điều này ngụ ý rằng bạn có thể sử dụng các thực thể HTML cho bất kỳ ký tự nào bạn cần thoát và thực sự bạn có thể:

Văn bản phải được viết bằng HTML với các thực thể HTML và thẻ HTML. Bạn có thể sử dụng bất kỳ phiên bản HTML nào mà trình duyệt của bạn hỗ trợ. Doclet tiêu chuẩn tạo mã tuân thủ HTML 3.2 ở nơi khác (bên ngoài các nhận xét tài liệu) với việc bao gồm các biểu định kiểu và khung xếp tầng. HTML 4.0 được ưa thích cho các tệp được tạo do các bộ khung.

Ví dụ: các thực thể cho ít hơn ký hiệu (<) và lớn hơn ký hiệu (>) nên được viết là <và >. Tương tự, ký hiệu (&) nên được viết là &.

— Frank V
nguồn

Nó hoạt động tốt hơn biểu thức nghĩa đen khi không được theo sau bởi khoảng

— trắng (

8

giải pháp của tôi là

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

— Kim chi
nguồn

2

Bạn đã có ý tưởng chung, hãy thử sử dụng biểu diễn bát phân: @

— Yuval Adam
nguồn

6

Đây không phải là bát phân.

— Joey

@có mật mã 0x40 ở dạng thập lục phân, là 64 trong số thập phân

— Binkan Salaryman