1. ev
  2. Soru-cevap
  3. Java'da Paketleri Nasıl Belgelerim?

Java'da Paketleri Nasıl Belgelerim?

2009-03-08 11 views

cevap

214

1.5 gibi, bir package-info.java dosyayı tanımlamak ve bir paket için standart bir javadoc tarzı yorumunu sağlayabilir:

com/foo/package-info.java:

/** 
* com.foo is a group of bar utils for operating on foo things. 
*/ 
package com.foo; 

//rest of the file is empty

Language specification for packages

kaynak

2009-03-08 22:42:24

+2

Doğrudan bağlantıya ulaşmak için linke tıklayın: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa

+2

intellij'de bir pakete ve seçeneğe sağ tıklayabilirsiniz. Bunu oluşturmak için yeni dosya menüsü altında olmalı – bsautner

3

Paket düzeyinde package.html dosya ile (yani, bu dizinin dizininde). Bu Java 1.4 zamana kadar

kaynak

2009-03-08 22:18:50

+1

Daha Deta ils? Dosya nasıl görünmeli? – jjnguy

+0

Bu, paketinizin açıklamasını içeren bir HTML dosyasıdır. Bu kadar! –

+3

Bunu yapmanın eski yolu budur. Java 1.5'ten itibaren, iki yoldan bahsetmek için package-info.java – k2col

38

tanımlanan <html> etiketiyle, tam oluşmuş HTML dosya olmalı, diğer cevaplar açıklandığı gibi, bir HTML dosyası package.html sağlamak zorunda kaldı.

Java 1.5'ten beri, düzenli bir Javadoc yorumu (HTML yok) içeren bir package-info.java sağlayabilirsiniz. İkincisi, size bazı ekstra özellikler (özellikle paket ek açıklamaları) verdiğinden tercih edilir.

Detayları: Sun's docs for javadoc

kaynak

2009-03-08 22:42:13 sleske

+2

+ 1'i ve bunlar arasındaki temel farkı kullanabilirsiniz. Bu arada, en azından IntelliJ IDEA şu anda package.html için daha iyi bir desteğe sahiptir (bir paketin üzerindeki Ctrl-Q, Javadocs paketini gösterir). – Jonik

+1

Önceki yorumuma güncellem: nowadays IDEA, package-info.java'nın sadece iyi olduğunu destekliyor. – Jonik

İlgili konular

 İlgili konular