Javadoc yorumlarında Markdown
Daha iyi okunabilirlik için Javadoc yorumlarını HTML yerine Markdown ile yazın.
Kod Karşılaştırması
✕ Java 8
/**
* Returns the {@code User} with
* the given ID.
*
* <p>Example:
* <pre>{@code
* var user = findUser(123);
* }</pre>
*
* @param id the user ID
* @return the user
*/
public User findUser(int id) { ... }
✓ Java 23+
/// Returns the `User` with
/// the given ID.
///
/// Example:
/// ```java
/// var user = findUser(123);
/// ```
///
/// @param id the user ID
/// @return the user
public User findUser(int id) { ... }
Bu kodda bir sorun mu gördünüz? Bize bildirin.
Modern yöntem neden daha iyi
Doğal sözdizimi
HTML etiketleri yerine satır içi kod için backtick ve bloklar için ``` kullanın.
Yazmak daha kolay
{@code}, <pre>, <p> etiketlerine gerek yok — sadece Markdown yazın.
Editörlerde daha iyi
Markdown, modern IDE'lerde ve metin editörlerinde güzel bir şekilde görüntülenir.
Eski Yaklaşım
HTML tabanlı Javadoc
Modern Yaklaşım
Markdown Javadoc
JDK'dan itibaren
23
Zorluk
Başlangıç
JDK Desteği
Javadoc yorumlarında Markdown
Mevcut
JDK 23'ten itibaren kullanılabilir (Eylül 2024)
Nasıl çalışır
Java 23, geleneksel /** */ HTML tabanlı biçime alternatif olarak /// Markdown stilinde Javadoc yorumlarını tanıtır. Markdown sözdizimi yazmak ve okumak için daha doğaldır; kod blokları, vurgu, listeler ve bağlantılar için destek sunar. Derleyici, javadoc çıktısı için Markdown'ı HTML'ye dönüştürür.
İlgili Belgeler