¿Hay alguna manera (o un editor) que me permita vincular enlaces de imágenes/archivos/http desde un archivo fuente (* .java por ejemplo), algo así como un documento de texto enriquecido?Agregar imágenes al código fuente
De esta manera, mientras que la lectura del código que pueda ver rápidamente la imagen adjunta (aumentando los comentarios), en lugar de abrir el navegador, etc.
Javadocs son HTML, por lo que sólo puede incrustar imágenes allí:
/**
* This class does some funky stuff (see diagram).
* <img src="relative/path/to/your/image.png" />
*
*/
public class FunkyClass{
}
Eclipse felizmente le mostrará las imágenes en la vista o en javadoc se cierne sobre el comentario. Otros IDEs pueden o no hacer lo mismo.
Obviamente usted tiene que asegurarse de alguna manera que las imágenes se despliegan con los javadocs ...
Por estándar de la industria, el código fuente es casi siempre sólo texto (sea codificado en ASCII o Unicode). Siempre puedes dibujar un arte ASCII. ;-)
No necesariamente. Los estándares de documentación de estilo de código de Microsoft permiten enlaces a tipos, etc. en la documentación. – Joe
bien, también lo hace Java, por supuesto. pero esos enlaces se implementan en ascii a través de las etiquetas javadoc –
. Estas son marcas, y todavía se hacen en texto solamente. – Santa
Puedes añadir <img src=""> y <a href=""> en el javadoc de sus clases.
Probablemente tenga herramientas y complementos que le permitan ver fácilmente el Javadoc de su archivo.
Un buen ejemplo de la mezcla de imágenes y enlaces en Javadoc es JRootPane
buen ejemplo, pero arte horrible. estas llaves son del infierno :-) –
¿Estás bromeando? No puedo creer lo que veo. Irónicamente, esto está en la GUI parte del docu ... +1 por mostrarme esta obra maestra de las bellas artes. – brimborium
Como muchos dice que usted puede usar, pero por ejemplo en Eclipse que encouter error si no se declara "alt" y si se utiliza "cierre automático" etiqueta como
<img alt="image desc" src="path/img.jpg">
parece no givin error =)
Intenté '
' y funcionó para mí, sin 'alt'. –
hasanghaforian
Bueno, tal vez podría ser la versión de Eclipse (kepler para mí) que no acepta alt faltante pero use alt es más para SEO xP –
Véase también http://stackoverflow.com/questions/151744/do-you-use-ascii-art-to-decorate-your-code – polygenelubricants
si puedes hacerlo (por ejemplo, hackeando javadoc para tomar la imagen cruda html), es pr Posiblemente una mala idea: ¿qué sucede si el recurso remoto deja de estar disponible por alguna razón? –
Si uso eclipse, ¿entonces tal vez haya algo que pueda hacer el plugin eclipse? @Richard Bueno, la imagen se ubicará justo a lo largo del código en el mismo directorio. @polygenelubricants, gracias por los enlaces, siempre puedo convertir mi imagen en un arte ascii. – portoalet