java - generate - intellij idea documentation
¿Cómo ver JavaDoc en IntelliJ IDEA? (11)
Esta pregunta ya tiene una respuesta aquí:
Acabo de pasar de Eclipse a IntelliJ y me falta una característica de Eclipse: cuando se coloca el mouse sobre un método, muestra información javadoc Descubrí (puede estar equivocado) que la forma de mostrar es un comando de atajo + J. Cuando hago clic, me sale algo mal, por favor vea en la captura de pantalla a continuación. Por favor, consejos cómo puedo obtener rápidamente la información javadoc. Necesito al menos saber qué tipo devuelve un método.
Alternativamente, puede colocar el cursor sobre el elemento y mostrar JavaDoc usando
CTRL + Q
que es el atajo por defecto
Edición: Como mencionó Methical en Mac, el acceso directo es
CTRL + j ( ^ + j no ⌘ + j )
Configuración de IntelliJ IDEA CE 2016.3.4 para habilitar JavaDocs en el mouse del mouse. Estoy ejecutando IntelliJ IDEA en Mac OS pero creo que Linux / Windows debería tener opciones similares.
Copias de seguridad automáticas: ID de IntelliJ IDEA > Preferences > Editor > General > Code Completion
Documentación en movimiento del mouse: IntelliJ IDEA > Preferences > Editor > General
NOTA: Presione el botón Aplicar para aplicar estas configuraciones
El más cercano a Eclipse será Ctrl + Button2 Click (Scroll click)
Se llama Quick Doc en IntelliJ, deseo que los muchachos de JetBrains algún día agreguen documentos rápidos como Eclipse con Ctrl + Mouse Move , es mucho mejor.
En mi caso, solo con mover el mouse es un poco molesto, por lo que si busca en Preferencias / Configuración -> Mapa de teclas para "documentación rápida" encontrará:
- Win-Linux: " Ctrl + Q " y " Ctrl + Button2 Click " (clic de desplazamiento)
- Mac: " Ctrl + J " y " Ctrl + Button2 Click " (clic de desplazamiento)
Hay una buena característica que muestra documentación rápida cuando el mouse está sobre el elemento.
IntelliJ 14
Editor / General -> Mostrar documentación rápida sobre el movimiento del mouse
versiones anteriores
Agregue la siguiente línea al archivo idea.properties:
auto.show.quick.doc=true
Me he dado cuenta de que seleccionar el nombre del método y presionar F2 (Documentación rápida) muestra que es JavaDoc. Estoy usando Intellij 2016, y Eclipse Keymap
Para mí, no era solo abrir la ventana de javadoc, sino también hacer que se presentara el javadoc completo. Aún puede obtener un javadoc disperso que se basa únicamente en la firma del método si está importando bibliotecas desde un repositorio de Maven y no le dice a Idea que incluya los javadocs en la descarga. Asegúrese de marcar la opción "JavaDocs" en el cuadro de diálogo "Descargar biblioteca del repositorio de Maven", que se encuentra en Estructura del proyecto -> Configuración del proyecto -> Bibliotecas.
Para reflejar mejor la funcionalidad de Eclipses, habilite las siguientes configuraciones:
- Configuración de IDE / Editor -> Otro . Mostrar documento rápido sobre el movimiento del mouse
- Configuración de IDE / Editor / Finalización de código -> Documentación Autopopup
Para ver el javadoc en el menú de autocompletar, pulsa ''.'' para obtener la ventana emergente, luego coloque el cursor sobre el objeto con el que está trabajando, una vez que obtenga la ventana emergente javadoc, puede seleccionar un elemento en la ventana emergente para cambiar el javadoc. No es ideal ... Pero es algo.
Como otra nota. La funcionalidad de búsqueda del menú de opciones es muy útil. Simplemente escriba ''doc'' y verá todas las opciones para doc.
Además, buscar "autopopup doc" no solo encontrará cada una de las opciones, sino que también las resaltará en el menú. ¡Bastante impresionante!
Edición: Más allá de la pregunta inicial, esto podría ser útil para las personas que solo desean un acceso rápido y fácil a los documentos.
Después de usar esto por unos días más, parece que acostumbrarse a usar la tecla de acceso rápido es la forma más eficiente. Se abrirá la documentación de cualquier cosa en el lugar donde se encuentre el marcador de entrada de texto para que nunca tenga que tocar el mouse. Esto funciona también en la ventana emergente intellisense y se mantendrá arriba mientras navega hacia arriba y hacia abajo.
Personalmente, Ctrl + Q en Windows no era ideal, así que lo reasigné a Alt + D. La reasignación se puede hacer bajo IDE Settings / Keymap. Una vez en el menú del mapa de teclado, simplemente busque Documentación rápida.
Vaya a Configuración -> Editor -> General y luego active Mostrar documentación rápida con el movimiento del mouse
IntelliJ IDEA 15 agregó esta característica
Ahora está disponible como EAP.
Como puede ver en la siguiente imagen, la posición del cursor no influye en la posición del cursor:
Esta función se implementó en IntelliJ IDEA 15 142.4675.3 Notas de la versión .
Utilizar View | Documentación rápida o el método abreviado de teclado correspondiente (de manera predeterminada: Ctrl + Q en Windows / Linux y Ctrl + J en Mac). Consulte la documentation para más información.
También es posible habilitar la ventana emergente automática de JavaDoc en la finalización del código explícito (invocado por un atajo) en Settings | Editor | General | Finalización del Code completion ( documentación de Autopopup ):
Otra forma de ver el documento rápido es con el movimiento del mouse :
