estoy escribiendouna biblioteca que insertaya probado en la unidad código de ejemplo (su código fuente, salida y cualquier archivo de entrada) en JavaDoc, con muchas posibilidades de personalización. La forma principal de usar esta biblioteca es con taglets en línea,como

{@.codelet.and.out my.package.AGreatExample}
{@.codelet my.package.AGreatExample}
{@.file.textlet examples\doc-files\an_input_file.txt}
{@.codelet.and.out my.package.AGreatExample%eliminateCommentBlocksAndPackageDecl()}

Desde costumbretaglets (e inclusodoclets) exigircom.sun, esto significa que no son tan multiplataforma como Java en sí. (No estoy seguro si esto es relevante, pero la palabra "javadoc" - e incluso la subcadena "doc" - no está en elEspecificaciones del lenguaje Java 8.)

No me gusta la idea de escribir una biblioteca limitada de esta manera. ¿Entonces qué hago? Mis pensamientos hasta ahora son que

Para aprovechar el analizador javadoc existente, me quedo con elcom.sun Taglets. Sin embargo, hago esta confianza encom.sun tan "delgado" como puede ser. Es decir, pongo la menor cantidad de código posible en la clase de etiqueta, dejando la mayor parte del código en otro lugar, donde no se depende decom.sun.Trabajo para crear mi propio analizador, quesolamente busca mis taglets específicos. Esto es un dolor, pero no demasiado horrible. Usted itera a través de las líneas de cada archivo fuente Java, buscando\{@\.myTagletName (.*?)\}. Una vez que captura ese texto, es más o menos lo mismo que el código dentro delcom.sun TagletEste analizador debería ejecutarse antes de ejecutar javadoc y, por lo tanto, requeriría una estructura de directorio duplicada. (1) su código original, con las etiquetas personalizadas no analizadas, (2) el duplicado de ese código, con salida analizada. Yo copiaríatodas codifique en el directorio duplicado, y luego analice solo aquellos archivos Java que se sabe que tienen estos taglets (clases que están "registradas" de alguna manera con el analizador).

¿Es este un enfoque razonable? ¿Ya existe un analizador de javadoc / taglet multiplataforma, por lo que no tengo que rodar el mío? ¿Hay algo multiplataforma que sea taglet-me gusta ya por ahi? Es JavaDocsí mismo ¿No es multiplataforma, o solo taglets y doclets personalizados?

Me gustaría tener una perspectiva aproximada de cuántas personas estoy bloqueando de mi biblioteca debido a esta decisión (usar taglets en línea), pero sobre todo estoy buscando una solución a largo plazo.

(A pesar de mi enlace Java 8 anterior, estoy usando Java 7.)

Gracias a @fge por la sugerencia de etiqueta, que es más elegante que miidea originaly a @Michael por lo ominoso pero útilcom.sun advertencias