Java LanguageDocumentazione del codice Java

introduzione

La documentazione per il codice java viene spesso generata usando javadoc . Javadoc è stato creato da Sun Microsystems allo scopo di generare documentazione API in formato HTML dal codice sorgente java. L'utilizzo del formato HTML offre la comodità di essere in grado di collegare insieme documenti correlati.

Sintassi

  • / ** - avvio di JavaDoc su una classe, un campo, un metodo o un pacchetto
  • @author // Per nominare l'autore della classe, interfaccia o enum. È richiesto.
  • @version // La versione di quella classe, interfaccia o enum. È richiesto. È possibile utilizzare macro come% I% o% G% affinché il software di controllo del codice sorgente compili il pagamento.
  • @param // Per mostrare gli argomenti (parametri) di un metodo o di un costruttore. Specifica un tag @param per ogni parametro.
  • @return // Per mostrare i tipi di ritorno per i metodi non void.
  • @exception // Mostra quali eccezioni possono essere generate dal metodo o dal costruttore. Le eccezioni che DEVONO essere catturate dovrebbero essere elencate qui. Se lo desideri, puoi anche includere quelli che non devono essere catturati, come ArrayIndexOutOfBoundsException. Specifica una @ eccezione per ogni eccezione che può essere generata.
  • @throws // Uguale a @exception.
  • @see // Collegamenti a un metodo, campo, classe o pacchetto. Utilizzare sotto forma di package.Class # qualcosa.
  • @since // Quando questo metodo, campo o classe è stato aggiunto. Ad esempio, JDK-8 per una classe come java.util.Optional <T> .
  • @serial, @serialField, @serialData // Utilizzato per mostrare serialVersionUID.
  • @deprecated // Per contrassegnare una classe, un metodo o un campo come deprecato. Ad esempio, uno sarebbe java.io.StringBufferInputStream . Vedi un elenco completo delle classi deprecate esistenti qui .
  • {@link} // Simile a @see, ma può essere utilizzato con testo personalizzato: {@link #setDefaultCloseOperation (int closeOperation) vedi JFrame # setDefaultCloseOperation per maggiori informazioni}.
  • {@linkplain} // Simile a {@link}, ma senza il carattere del codice.
  • {@code} // per codice letterale, ad esempio tag HTML. Ad esempio: {@code <html> </ html>}. Tuttavia, questo utilizzerà un carattere a spaziatura fissa. Per ottenere lo stesso risultato senza il carattere monospaziale, utilizzare {@literal}.
  • {@literal} // Uguale a {@code}, ma senza il carattere a spaziatura fissa.
  • {@value} // Mostra il valore di un campo statico: il valore di JFrame # EXIT_ON_CLOSE è {@value}. In alternativa, puoi collegare a un determinato campo: utilizza il nome dell'app {@value AppConstants # APP_NAME}.
  • {@docRoot} // La cartella radice del codice HTML JavaDoc relativa al file corrente. Esempio: <a href="{@docRoot}/credits.html"> Crediti </a>.
  • L'HTML è permesso: <code> "Ciao cookie" .substring (3) </ code>.
  • * / - fine della dichiarazione JavaDoc

Osservazioni

Javadoc è uno strumento incluso con JDK che consente di convertire i commenti nel codice in una documentazione HTML. La specifica dell'API Java è stata generata utilizzando Javadoc. Lo stesso vale per gran parte della documentazione delle librerie di terze parti.

Documentazione del codice Java Esempi correlati