Domande taggate «javadoc»

Javadoc è un sistema estensibile di generazione della documentazione che legge i commenti appositamente formattati nel codice sorgente Java e genera documentazione compilata. In genere viene utilizzato per produrre documentazione API sotto forma di pagine Web HTML.

Come posso fare riferimento al valore di un campo statico finale nella classe?

Utilizzando JavaDoc, come posso fare riferimento al valore di un campo statico finale nella classe? Voglio che ???in questo esempio sia sostituito dal valore del campo STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * …

96 java documentation javadoc

Come scrivere Javadoc di proprietà?

Spesso mi trovo di fronte a un dilemma quando scrivo javadoc per proprietà / membri di una classe POJO "semplice" che contiene solo proprietà e getter e setter (stile DTO) .... 1) Scrivi javadoc per la proprietà o ... 2) Scrivi javadoc per il getter Se scrivo javadoc per la …

93 java javadoc

Completamento automatico di @author in Intellij

Sto migrando da Eclipse a Intellij Idea. Una cosa che non sono ancora riuscita a capire è il completamento automatico del @authortag JavaDoc. Quando si digita @ain Eclipse, ci sono due proposte: @author - author name @author Come ottengo la prima proposta in Intellij (è anche possibile?)? E se è …

93 intellij-idea javadoc

Come creare più livelli di rientro in Javadoc?

Supponiamo che, come parte della documentazione del codice (Javadoc), si desideri indicare che le relazioni tra gli elementi utilizzano un rientro profondo. Come posso creare un elenco nidificato come: qualche elemento qualche altro elemento ancora qualche altro elemento

89 documentation javadoc indentation nested-lists

Dettagli della differenza tra @see e @inheritDoc

Ho esaminato il riferimento JavaDoc e, sebbene comprenda la differenza di base tra @see(vari collegamenti) e {@inheritDoc}(esportazione del commento JavaDoc della superclasse), ho bisogno di chiarimenti su come le cose sono effettivamente implementate. Nell'IDE di Eclipse quando seleziono "Genera commenti elemento" per il metodo ereditato (dall'interfaccia, o toString () sovrascrivi …

87 java javadoc comments

Come Javadoc gli enumerativi individuali di una classe

Sto scrivendo il javadoc per una classe che contiene le proprie enumerazioni. C'è un modo per generare javadoc per le singole enumerazioni? Ad esempio, in questo momento ho qualcosa del genere: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; Tuttavia, questo …

84 java enums javadoc

JDK 11+ e Javadoc

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Qualcuno è stato in grado di far funzionare javadoc senza dover cambiare la versione di origine in 1.8 (come suggerito in altri forum)? …

13 java maven javadoc java-11 maven-javadoc-plugin

Come documentare i parametri di Java Record?

Come si può documentare i parametri del Record Java ? Mi riferisco ai parametri che finiscono per diventare parametri di costruzione, campi di classe. Provai: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { …

12 java intellij-idea javadoc java-14 java-record

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.

Licensed under cc by-sa 3.0 with attribution required.