2009-09-21 7 views
11

Existe-t-il un outil qui remplace javadoc par quelque chose qui soit plus une syntaxe de type Wiki que la syntaxe HTML de JavaDoc normal?Existe-t-il un remplacement javadoc qui utilise une syntaxe semblable à Wiki?

Un de mes problèmes est que je lis surtout JavaDoc sous forme de source. Même pour les bibliothèques externes, j'essaie d'avoir la source attachée afin que je puisse y accéder à partir de mon IDE, en vérifiant la documentation au-dessus du point d'entrée et si nécessaire le code ci-dessous.

L'autre problème est que les choses comme les listes et les exemples de code sont compliqués à écrire, surtout si votre IDE insiste pour mettre des étoiles sur chaque ligne. Ce que je voudrais voir est quelque chose qui utilise une sorte de syntaxe Wiki avec au moins les caractéristiques suivantes:

  • listes
  • blocs de code
  • réticulation aux méthodes/classes

Il y a beaucoup d'autres choses qui seraient bien, mais je crois que ce sont les éléments essentiels.

Quelqu'un connaît-il un tel outil?

+0

Les blocs de code ne sont pas trop mauvais avec '{@code}'. Je pense que {@link} 'fonctionne assez bien pour lier les membres et les types. –

+0

pendant que vous pensez à l'affichage de type wiki, ce serait bien si vous pouviez aussi éditer le style wiki, et le replacer dans les commentaires. Je suppose que c'est demander un peu plus. – Carl

Répondre

3

Il ya un projet appelé WikiDoclet, je ne l'ai jamais utilisé, mais je serais intéressé de voir ce que vous en pensez.

Sur le site:

Ceci est une extension du doclet standard Javadoc fourni avec le JDK Java. Il ajoute un support pour ce que j'appelle le formatage Wiki. Ce que cela signifie, c'est que votre JavaDoc peut maintenant être formaté en utilisant des règles de texte qui sont plus faciles sur les yeux que HTML intégré dans JavaDoc. Par exemple, pour mettre l'accent sur un morceau de texte, vous l'entourez de étoiles. Les italiques avec soulignent. Lorsque le doclet est exécuté pour produire JavaDoc, ces règles sont évaluées et des substitutions html sont effectuées. Cette mise en forme devrait faciliter la lecture du code source java car elle ne sera plus encombrée de balises HTML. Cela est particulièrement vrai pour les listes à puces et pour les tableaux. Le HTML est toujours conservé, donc vous pouvez mélanger et faire correspondre comme vous le souhaitez.

Pour les autres formats de doclet, consultez doclet.com.

+0

Jolis liens - merci. Je vais essayer. –