Existe-t-il un moyen (ou un éditeur) permettant de lier un lien image/fichier/http depuis un fichier source (* .java par exemple), un peu comme un document riche?Ajouter des images dans le code source
De cette façon, en lisant le code que je peux regarder rapidement à l'image jointe (en augmentant les commentaires), au lieu d'ouvrir le navigateur, etc.
Javadocs sont HTML, vous pouvez simplement y incorporer des images:
/**
* This class does some funky stuff (see diagram).
* <img src="relative/path/to/your/image.png" />
*
*/
public class FunkyClass{
}
Eclipse se fera un plaisir de vous montrer les images dans la vue javadoc ou planant au-dessus du commentaire. D'autres IDE peuvent ou ne peuvent pas faire la même chose.
Évidemment, vous devez vous assurer d'une certaine manière que les images sont déployées avec les javadocs ...
Par la norme de l'industrie, le code source est presque uniquement du texte (Écris il est codé en ASCII ou en Unicode). Vous pouvez toujours dessiner un art ASCII. ;-)
Pas nécessairement. Les normes de documentation de style de code de Microsoft permettent des liens vers des types, etc., dans la documentation. – Joe
ok, tout comme java, bien sûr. mais ces liens sont implémentés en ascii via les balises javadoc –
Ce sont des annotations, et sont toujours faites en texte seulement. – Santa
Vous pouvez ajouter <img src=""> et <a href=""> dans la javadoc de vos classes.
Vous avez probablement des outils et des plug-ins qui permettent de voir facilement la Javadoc de votre fichier.
Un bon exemple de mélange des images et des liens dans Javadoc est JRootPane
bon exemple, mais art horrible. ces accolades sont de l'enfer :-) –
Vous plaisantez? Je ne peux pas en croire mes yeux. Ironiquement, c'est dans la partie GUI du docu ... +1 pour me montrer ce chef-d'œuvre de beaux-arts. – brimborium
Comme beaucoup dit que vous pouvez utiliser, mais par exemple dans Eclipse vous encouter erreur si vous ne déclarez pas « alt » et si vous utilisez « fermeture automatique » tag comme
<img alt="image desc" src="path/img.jpg">
ne semble pas erreur Givin =)
J'ai essayé '
' et cela a fonctionné pour moi, sans 'alt'. –
hasanghaforian
Eh bien, peut-être pourrait être la version d'Eclipse (kepler pour moi) qui n'accepte pas alt alt, mais l'utilisation de alt est plus pour SEO xp –
Voir aussi http://stackoverflow.com/questions/151744/do-you-use-ascii-art-to-decorate-your-code – polygenelubricants
si vous pouvez le faire (par exemple en piratant javadoc pour prendre l'image brute html), il est pr peut-être une mauvaise idée - que se passe-t-il si la ressource distante n'est plus disponible pour une raison quelconque? –
Si j'utilise eclipse, alors il y a peut-être quelque chose que le plugin eclipse peut faire? @Richard Eh bien, l'image sera juste assis le long du code dans le même répertoire. @polygenelubricants, merci pour les liens, je peux toujours convertir mon image en un art ascii. – portoalet