Javadoc'ta birden fazla girinti seviyesi nasıl oluşturulur?


89

Diyelim ki, kodunuzu (Javadoc) belgelemenin bir parçası olarak, derin girintiyi kullanarak öğeler arasındaki ilişkileri belirtmek istiyorsunuz.

İç içe geçmiş bir listeyi şu şekilde nasıl oluşturabilirim:

  • bazı unsurlar
    • başka bir unsur
      • yine de başka bir unsur

Yanıtlar:


134
<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

HTML'yi javadoc yorumlarında oldukça özgürce kullanabilirsiniz.

Güncelleme: Geldiği için denedim

<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>

ve Al

  • bir
    • bir nokta bir

Doğru yerleştirmenin daha iyi olduğuna katılıyorum.


2
İç içe geçmiş <ul> öğesinin bir <li> öğesinin içinde olması gerektiğini söyleyebilirim, karşılaştırma için bkz. W3.org/wiki/HTML_lists#Nesting_lists
user2622016

Bunu söyleyebilirsin, ama denemek farklı bir şey söylüyor.
Charlie Martin

1
@Charlie "Doğru yerleştirmenin daha iyi olduğuna katılıyorum." Demek yerine, nasıl düzgün yerleştirileceğini gösteren bir örnek yazabilirsin? Aksi takdirde, belki yeni başlayanlar yorumunuzu anlamayacak ve yukarıda belirtilen formu kullanacaktır.
Rauni Lillemets

2
User2622016'nın şu şekilde yazmanız gerektiği anlamına geldiğini anladım: <ul><li><ul>...</ul></li> </ul>, böylece en içteki <ul> .. </ ul > ayrıca bir <li> .. </li> bloğunun içindedir.
Rauni Lillemets

1
Açıkça ifade edilmiş bulamasam da (ve baktım), Oracle'ın belgelerinde kullanılan stil bu . Ayrıca NetBeans bundan şikayet ediyor. Öte yandan Intellij, </li>etiketleri mutlu bir şekilde ekliyor
SeverityOne

29

Doğru yol aşağıdaki gibidir:

/**
 * <ul>
 *   <li>some element
 *   <li><ul>
 *     <li>some other element
 *     <li><ul>
 *       <li>yet some other element
 *     </ul>
 *   </ul>
 * </ul>
 */

JavaDoc HTML'den ödünç alsa da, HTML değildir ve </li>etiketleri atlamanız gerektiği gibi , etiketleri çıkarmalısınız </p>.


1
Kapanış etiketlerinin atlanması için herhangi bir referans var mı?
friederbluemle

1
Evet, burada: oracle.com/technetwork/java/javase/documentation/… - açıktan ziyade örtük olmasına rağmen.
Önem DerecesiOne

Bu cevabın neden daha fazla olumlu oy vermediğini anlamayın.
John Smith

8

İç içe geçmiş liste kendi içinde olmalıdır <li>. <ul>geçerli bir alt öğe değil <ul>.

Yani örneğiniz şöyle olacaktır:

<ul>
  <li>some element</li>
  <li>
    <ul>
      <li>some other element</li>
      <li>
        <ul>
          <li>yet some other element</li>
        </ul>
      </li>
    </ul>
  </li>
</ul>

Kodunuz boş öğeler içeren bir liste ile sonuçlanır. HTML'de düzgün bir şekilde iç içe geçmiş olmasına rağmen, oluşturulan sonuç çirkin.
naXa
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.