Sto cercando alcuni consigli su come andare a leggere la documentazione online di vari pacchetti di classi e metodi per java.Come leggo la documentazione java?
Voglio dire tutta questa roba: http://java.sun.com/javase/6/docs/api/
E in effetti, leggerla solo quando necessario. Per il resto, segui un tutorial. Solitamente Googling "[keyword] tutorial sito: oracle.com" produce risultati sufficienti.
Aggiornamento a prendere quanto segue come un esempio per il quale si desidera trovare il Javadoc:
someString.split("\\.");
Qui someString è un'istanza di java.lang.String. Supponendo che ti piacerebbe iniziare dallo API documentation root (io preferisco piuttosto digitare solo "java.lang.string javase api site: oracle.com" nella barra degli indirizzi di Firefox per farcela dritta (se ti senti fortunato e non l'aveva già nella cronologia del browser), o semplicemente controllarlo nel mio IDE), quindi scorrere il frame principale su java.lang package e fare clic sul collegamento, quindi nel riepilogo della classe controllare lo String class e fare clic sul collegamento, quindi nel riepilogo del metodo, controllare split() method e fare clic sul collegamento.
Javadoc dell'API Java SE è conciso, ma piuttosto completo e fornisce collegamenti ad altri javadoc dove ci si aspetta che siano. Per esempio, nella parte inferiore del String#split() javadoc si vede un collegamento "Vedere anche" alla classe Pattern, che a sua volta spiega che roba regex nella classe introduzione.
questo non è quello che sto chiedendo. Questo è qualcos'altro. – David
Quindi è necessario chiarire di più. Se hai mai domande "Cosa fa' esattamente java.lang.String # split (String)? ", Allora vai al Javadoc di' java.lang.String', cerca il metodo 'split()' e leggi documentazione del metodo. Fai clic sul pacchetto, classe e metodo. – BalusC
questo potrebbe essere ciò che stavo parlando. davvero non lo so – David
leggerlo come necessario. Come in, nel contesto di un progetto. La documentazione è in gran parte un formato basato sulla necessità, non un formato di insegnamento di concetti.
In caso contrario, se si vuole realmente leggere qualcosa da imparare l'SDK per esempio, leggere un libro di insegnamento.
beh, mi sto chiedendo come lo leggo quando ne ho bisogno. – David
Forse se hai postato uno snippet di qualcosa che ti confondeva, potremmo aiutarti a decifrarlo? –
Vuoi dire che non sai come accedervi? O vuoi dire che non sai come trovare quello che ti serve. È una vasta gamma di informazioni, motivo per cui consiglio di iniziare con un libro Java. – codenheim
Il JavaDoc è solo un riferimento. È fantastico per rispondere a una domanda sul modulo "cosa fa questo (classe/metodo)?" ma è terribile per qualsiasi altra cosa.
Se sei confuso dal JavaDoc, dovresti prendere un libro o trovare un tutorial online. Usa la documentazione come riferimento per rispondere solo a domande specifiche e forse non sarai confuso.
Immagina di avere una stringa e stai cercando di capire come convertirla in maiuscolo. Guardate il javadoc per archi, a http://java.sun.com/javase/6/docs/api/java/lang/String.html (o dal vostro link qui sopra, basta scorrere per trovare stringa nella lista in basso a sinistra.
Troverete c'è un metodo ci chiama toUpperCase(). È possibile fare clic su di esso per trova i dettagli e vedrai tutti gli altri metodi lì, che descrivono il tipo di cose che puoi "fare" su una stringa
E c'è anche una lista di costruttori che ti dicono come puoi " crea un oggetto stringa
Forse non è troppo difficile per una stringa, quindi prova qualcosa di più complesso: come crei un BufferedOutputStream?
immaginare il javadoc come la navigazione album in iTunes. Il frame in alto a sinistra è un elenco di pacchetti. Questo è come un elenco di artisti. Selezionando uno di questi cambia ciò che è mostrato nel frame in basso a sinistra. Il frame in basso a sinistra è un elenco di Classi/Interfacce nel pacchetto selezionato sopra di esso. È come selezionare un artista e mostrare l'elenco degli album. È quindi possibile selezionare una delle classi/interfacce e una visualizzazione dettagliata di essa apparirà nel frame principale. Questo è come l'elenco delle tracce dell'album selezionato.
A parte analogia, i dettagli del frame principale mostrano tutte le informazioni pubbliche e protette necessarie per interagire con quella classe o interfaccia. Nella parte superiore mostra la gerarchia dell'ereditarietà e una descrizione della classe. Di seguito è riportato un riepilogo di tutti i campi, i costruttori e i metodi pubblici o protetti nella classe. È possibile fare clic su un collegamento su uno di questi per passare a una descrizione completa. Nella parte inferiore del riepilogo c'è un elenco di tutti i metodi ereditati.
Qualsiasi classe a cui viene fatto riferimento in un javadoc come argomento o tipi di ritorno saranno collegamenti. Se fai clic sul link, si passerà alla javadoc per quella classe. In questo modo è abbastanza facile navigare attraverso tutte le classi necessarie per capire cosa sta succedendo. Non è esattamente carino, ma funziona. Essendo html, puoi persino aprire i link in una nuova scheda e quindi aprire facilmente tutte le classi correlate contemporaneamente.
Un ultimo suggerimento - ci sono alcune opzioni extra nella parte superiore del riquadro dettagli. Uno che uso molto sono i collegamenti Frames/No Frames. Questo aggiungerà o rimuoverà i frame del pacchetto e della classe sulla sinistra. Se apri altre classi in nuove schede o, a volte, se trovi una lezione utilizzando google, finirai su una pagina senza cornici extra. Basta fare clic sul tag Frames e verranno aggiunti alla pagina.
La cosa più utile per me per l'apprendimento delle API Java SE era di fare "The Java Tutorials". Copre praticamente l'intero Java SE, in un modo molto più organizzato rispetto a JavaDocs. Dopo aver letto i bit che ti interessano, i JavaDocs avranno più senso da soli.
Di solito ho letto i JavaDocs per bit che mi interessano tramite l'IDE. Io uso Netbeans, che visualizza automaticamente JavaDoc come parte del suo completamento del codice. In questo modo, posso parzialmente digitare un nome di classe o metodo che sto pensando di utilizzare, quindi scorrere i JavaDocs dei suggerimenti finché non trovo ciò che voglio.
I secondi tutto quanto sopra utenti confuso. Per quanto mi riguarda, provengo da un avido background di utilizzo dell'API di Windows per VB classic, l'API Java non è illuminante.
Sì, l'API Java fornisce ampie informazioni su se stesso, su cosa fa ogni classe e sulla struttura di tutto; ma, per qualsiasi cosa utile durante lo sviluppo, è piuttosto scoraggiante piuttosto che riferirsi a soluzioni e codice utilizzabile.
Considerare che chiunque sia nuovo in Java difficilmente può ricordare o memorizzare quali funzioni fanno parte di ogni pacchetto. Quindi trovare un metodo, una funzione, una classe o un termine già definito è un incubo.
Riguardo ai documenti API Java: È una cosa essere diversi ed eccezionalmente specifici per l'ambiente e il linguaggio; è un gioco di palla completamente diverso quando è più focalizzato sul fatto di essere semplicemente diversi nonostante sia incoerente agli occhi dei principianti.
Credo che le persone troveranno i passaggi per iniziare la codifica molto semplificata da un'importante revisione del layout della documentazione API disorganizzata di Java.
Grazie SoAwesomeMan;) Anche se mi piace molto parlare da solo, essere stressato mentre la risposta difficilmente apporta grammatica. Badate che l'inglese non è la mia prima lingua. –
Intendi dire che stai riscontrando problemi con l'utilizzo di javadoc? Come se non riuscissi a trovare le classi e i metodi che desideri?O vuoi dire che non sono molto utili a capire cosa è a tua disposizione nel Java SDK? –
Mi piace questa domanda. Personalmente trovo che la documentazione java in linea sia un pasticcio imperscrutabile. Se qualcuno ha qualche consiglio su come farsi testa o croce, mi piacerebbe saperlo anche io! –
È improbabile che lo chieda a questo senza prima cercare di cercare qualcosa. Sospetto che tu abbia avuto problemi con qualcosa, si riferisca ai documenti e li trovi inutili. Puoi dirci di cosa stavi avendo problemi? – Cam