Estoy buscando algunos consejos sobre cómo leer la documentación en línea de varias clases de paquetes y métodos para Java.¿Cómo leo la documentación de Java?
quiero decir todas estas cosas: http://java.sun.com/javase/6/docs/api/
Y de hecho, léelo solo cuando sea necesario. Para el remanente, ve a través de un tutorial. Por lo general, googlear el "sitio tutorial [de palabras clave]: oracle.com" arroja suficientes resultados.
actualización para tomar la siguiente como un ejemplo para los que desea encontrar el Javadoc:
someString.split("\\.");
Aquí someString es una instancia de java.lang.String. Asumiendo que le gustaría comenzar desde el API documentation root (yo prefiero escribir simplemente "java.lang.string javase api site: oracle.com" en la barra de direcciones de Firefox para entenderlo correctamente (si se siente afortunado) y no lo tenía ya en el historial del navegador), o para simplemente verificarlo en mi IDE), luego desplácese en el cuadro principal al java.lang package y haga clic en el enlace, luego en el resumen de clase, marque el String class y haga clic en el enlace luego, en el resumen del método, marque el split() method y haga clic en el enlace.
El Javadoc de la API de Java SE es conciso, pero bastante completo y proporciona enlaces a otros javadocs donde se espera que estén. Por ejemplo, en la parte inferior del javadoc String#split(), verá un enlace "Ver también" a la clase Pattern, que a su vez explicará las expresiones regulares en la introducción de la clase.
esto no es lo que estoy preguntando. Esto es otra cosa. – David
Luego necesita aclarar más. Si alguna vez te preguntas "¿Qué hace' java.lang.String # split (String) 'exactamente?", Entonces ve al Javadoc de 'java.lang.String', busca el método' split() 'y lee el documentación del método. Haga clic en su camino a través del paquete, clase y método. – BalusC
actualmente esto puede haber sido de lo que estaba hablando. realmente no lo sé – David
Léelo según sea necesario. Como en, en el contexto de un proyecto. La documentación es, en gran medida, un formato basado en las necesidades, no un formato de enseñanza de conceptos.
De lo contrario, si quiere realmente lea algo para aprender el SDK, por ejemplo, lea un libro de enseñanza.
bien, me pregunto cómo lo leo cuando lo necesito. – David
¿Tal vez si publicaras un fragmento de algo que te confundía, podríamos ayudar a descifrarlo? –
¿Quiere decir que no sabe cómo acceder? ¿O quiere decir que no sabe cómo encontrar lo que necesita? Es una gran variedad de información, por lo que recomiendo comenzar con un libro de Java. – codenheim
El JavaDoc es simplemente una referencia. Es genial para responder una pregunta sobre la forma "¿qué hace esto (clase/método)?" pero es terrible para cualquier otra cosa.
Si el JavaDoc te confunde, deberías buscar un libro o encontrar un tutorial en línea. Use la documentación como referencia para responder solo preguntas específicas, y tal vez no esté tan confundido.
Imagine que tiene un String, y está tratando de encontrar la forma de convertirlo a mayúsculas. Mira el Javadoc para cuerdas, en http://java.sun.com/javase/6/docs/api/java/lang/String.html (o desde el enlace de arriba, solo que desplazarse hacia abajo para encontrar cadena de la lista inferior izquierda.
Usted encontrará que hay un método allí llamado toUpperCase(). Puede hacer clic en él para encuentra los detalles. Y verás todos los otros métodos que describen el tipo de cosas que puedes "hacer" en un String.
Y también hay una lista de constructores que te dicen cómo puedes hacerlo " crear "un objeto de cadena.
Tal vez no sea demasiado difícil para un String, por lo que intenta algo más complejo: ¿Cómo se crea un BufferedOutputStream?
Imagine el javadoc como navegación de álbumes en iTunes. El marco superior izquierdo es una lista de paquetes. Eso es como una lista de artistas. Al seleccionar uno de esos cambios, se muestra lo que se muestra en el cuadro inferior izquierdo. El marco inferior izquierdo es una lista de Clases/Interfaces en el paquete seleccionado arriba. Eso es como seleccionar un artista y mostrar la lista de álbumes. Luego puede seleccionar una de las clases/interfaces y una vista detallada de la misma aparecerá en el cuadro principal. Eso es como la lista de pistas para el álbum seleccionado.
Aparte de la analogía de iTunes, los detalles del marco principal muestran toda la información pública y protegida necesaria para interactuar con esa clase o interfaz. En la parte superior, muestra la jerarquía de herencia y una descripción de la clase. A continuación se muestra un resumen de todos los campos, constructores y métodos públicos o protegidos en la clase. Puede hacer clic en un enlace en cualquiera de ellos para pasar a una descripción completa. En la parte inferior del resumen hay una lista de todos los métodos heredados.
Cualquier clase a la que se hace referencia en un javadoc como argumento o tipos devueltos serán enlaces. Si hace clic en el enlace, navegará al javadoc para esa clase. De esta manera es bastante fácil navegar a través de todas las clases necesarias para descubrir qué está pasando. No es exactamente bonito, pero funciona. Al ser html, incluso puede abrir enlaces en una nueva pestaña y, por lo tanto, abrir fácilmente todas las clases relacionadas a la vez.
Un último consejo: hay algunas opciones adicionales en la parte superior del panel de detalles. Uno que uso mucho son los enlaces Frames/No Frames. Esto agregará o eliminará los marcos de paquete y clase a la izquierda. Si abre otras clases en pestañas nuevas o, a veces, si encuentra una clase que use google, terminará en una página sin marcos adicionales. Simplemente haga clic en la etiqueta Frames y se agregarán a la página.
Lo más útil para mí al aprender las API de Java SE fue hacer "The Java Tutorials". Cubre prácticamente todo el Java SE, de una manera mucho más organizada que los JavaDocs. Después de leer los bits que le interesan, los JavaDocs tendrán más sentido por sí solos.
Normalmente leo los JavaDocs para los bits que me interesan a través del IDE. Utilizo Netbeans, que muestra JavaDoc automáticamente como parte de la finalización del código. De esa manera, puedo escribir parcialmente el nombre de una clase o método que estoy pensando utilizar, y luego navegar a través de los JavaDocs de las sugerencias hasta que encuentre lo que quiero.
En segundo lugar todos los usuarios confundidos anteriormente. En cuanto a mí, que proviene de un fondo ávido de usar la API de Windows para VB classic, la API de Java no es esclarecedora.
Sí, la API de Java proporciona amplia información sobre sí misma, lo que hace cada clase y la estructura de todo; pero, para cualquier cosa útil durante el desarrollo, es bastante disuasorio en lugar de referirse a las soluciones y al código utilizable.
Considere que cualquier persona nueva en Java apenas puede recordar o memorizar qué funciones forman parte de cada paquete. Entonces, encontrar un método, función, clase o término ya definido utilizado es una pesadilla.
En cuanto a los documentos API de Java: Una cosa es ser diferente y excepcionalmente específico para el entorno y el idioma; es un juego de pelota completamente diferente cuando está más centrado en simplemente ser diferente a pesar de ser incoherente para los ojos de los principiantes.
Creo que las personas encontrarán los pasos para la codificación inicial simplificados por una importante revisión del diseño desorganizado de la documentación API de Java.
Gracias SoAwesomeMan;) Aunque la mayoría de las veces disfruto hablar por mí mismo, estar estresado mientras respondo apenas beneficia la gramática. Te importa que el inglés no es mi primer idioma. –
¿Quiere decir que tiene problemas para usar javadocs? ¿No puedes encontrar las clases y métodos que quieres?¿O quiere decir que no son muy útiles para comprender lo que está disponible para usted en el SDK de Java? –
Me gusta esta pregunta. Personalmente encuentro que la documentación en línea de Java es un desastre inescrutable. Si alguien tiene algún consejo sobre cómo hacer cara o cruz, ¡también me gustaría saberlo! –
Es poco probable que preguntes esto sin antes intentar buscar algo. Sospecho que estabas teniendo problemas con algo, refiriéndome a los documentos, y los encontré inútiles. ¿Puedes decirnos con qué tenías problemas? – Cam