1. Accueil
  2. Question et réponse
  3. Balisage Stackoverflow pour javadoc

Balisage Stackoverflow pour javadoc

2011-05-23 3 views
25

Après un moment, je suis de retour en train d'écrire JavaDoc. En même temps, j'aimais beaucoup le balisage de SO, qui est beaucoup plus lisible en clair qu'en HTML. (Même le coche que je n'ai jamais utilisé auparavant, jamais).Balisage Stackoverflow pour javadoc

/** 
* I'm talking about things like <code>ClassName</code> here. 
* <p> 
* And of course the well known <code>&lt;p&gt;</code>.<br> 
* Should I go on? 
*/

Avez quelqu'un écrit une thingy filtre qui se traduit par balisage SO HTML dans le toolchain JavaDoc?

Alternativement comme commentaires des pointeurs seraient les bienvenus comment écrire des extensions à JavaDoc avec une telle fonctionnalité (je suis principalement intéressé par l'interface si elle est disponible).

Source

2011-05-23 vbence

+3

Alors que je peux certainement voir l'appel d'avoir, je ferais attention: beaucoup, beaucoup d'outils supposent que les commentaires JavaDoc contiennent HTML et cette hypothèse pourrait être difficile à éteindre. Par exemple, par défaut, Eclipse formate les commentaires JavaDoc en supprimant les espaces non importants (pour HTML). Cela ruinerait le balisage. –

Répondre

22

Il semble y avoir un Markdown Doclet pour Javadoc, qui devrait faire ce que vous voulez.

Il est fabriqué par StackOverflow-user Richard Nichols. Il a écrit a blog post dessus, qui inclut une capture d'écran, de quelques exemples d'entrée/sortie.

Source

2011-05-23 08:20:29

+4

Le lien à la réponse originale de Richard, si quelqu'un veut voter, aussi: http://stackoverflow.com/questions/1026553/are-there-some-good-and-modern-alternatives-to-javadoc/ 1043720 # 1043720 –

+1

Il semble que le projet soit un peu dépassé:/ –

+0

Malheureusement, le premier lien est maintenant cassé, tout comme chaque lien pointant vers Google Code. – Adowrath

Questions connexes

 Questions connexes