javadoc

Sono uno sviluppatore Java e sono interessato a migliorare la qualità dei miei commenti Javadoc nel codice e nei programmi ch ... er confrontare il mio Javadoc esistente(s) per modellare esempi e mantenere le best practice per la documentazione API Java.

@jls 4.3.2. L'oggetto di classe @jls 9.8 Interfacce funzionali @jls 9.4.3 Corpo del metodo di interfaccia @ dal 1.8 */ Trovato questo javadoc in alcune classi java di base, qual è il significato di questo? quando usare per scrivere javadoc?

Il mio codice java è stato commentato usando la struttura /** per ogni funzione. Quindi voglio generare automaticamente tutta ... enjdk-6-jdk E riavviando eclipse il comando javadoc apparato: /usr/bin/javadoc ed eseguito perfettamente. Grazie a tutti.

Nel mio Javadoc do un esempio di come usare la mia classe. Poiché questo è un esempio a più righe, è stato raccomandato su St ... esto è quello che sembra. Ho sostituito anche i tag di codice con {@code} ma il risultato è lo stesso. Questo è il codice:

Sto cercando di aggiungere sequenze UML e diagrammi di classe al mio codice Java, al fine di spiegare i suoi interni e concet ... gini PNG / GIF allegate all'API HTML. Quale strumento posso usare per l'automazione di questo processo (sto usando Maven 3)?

Nel mio report di documentazione API Enunciato, ho bisogno di cambiare il carattere di un testo di commento in tipo di carattere "Courier New". È è possibile?

Sto cercando di aggiungere un motore di ricerca personalizzato a chrome omnibox, uno di questi che volevo era la documentazio ... legamento con la variabile "% s " nella posizione della frase di ricerca. +Forse un motore di ricerca migliore per Java Doc?

Ho usato Eclipse nel mio stage, e nell'ultimo test che ho fatto mi hanno dato un campione di un vero progetto da risolvere, e ... vadoc", ma da quando l'ho cancellato nel mio codice, la cosa del passaggio del mouse non funzionava più. Grazie in anticipo.

Quando voglio consultare l'API java di solito vado su un motore di ricerca e digito ad esempio "Java String" che mi dà il lin ... enere sempre diretto alla versione più recente? In alternativa, qual è il tuo modo preferito per cercare API documentazione?

Sto lavorando con oggetti come IReportAppFactory,ISessionMgr,IEnterpriseSession, IInfoStore, IReport e altri da cecore.jar, c ... c'è Javadoc collegato. Ho provato a setacciare Internet per loro senza alcun risultato. Qualche link per il Javadoc? Grazie!

Sto cercando di generare la documentazione, usando javadoc, da uno o due file jar scaricati (con la fonte ovviamente, dopo av ... guibili per tutte le dipendenze di terze parti verranno scaricati sotto GRADLE_HOME durante la compilazione. Abbastanza bene!

Questa domanda ha già risposte qui: ... strata l'immagine, ma quando provo a rivedere Javadoc nell'idea mostra solo lo stub dell'immagine. Come posso gestire questo?

Dopo oltre un'ora di debug, mi sono reso conto che non ero riuscito a creare un'istanza di un oggetto prima di fare qualcosa ... è rosso? Cosa significa? Sento che questo mi aiuterebbe a giocare detective e trovare la vera fonte del mio errore. Grazie!

Chiuso . Questa domanda è basata sull'opinione . Attualmente non accetta risposte. ... Scanner può bloccare? C'è una ragione legittima per omettere queste informazioni, o è solo un caso di scarsa documentazione?

I don't understand this point: Block comments can start with /*-, which is recognized by indent(1) as the beginning of a bl ... . How should a comment be formed correctly, which then will not be changed automatically if it is not according to the rules?