2012-08-06 17 views
7

Dado que el lenguaje Apex de Salesforce.com es "similar a Java", me gustaría usar javadoc o Doxygen para generar documentación API para el paquete que planeamos lanzar en App Exchange.Documentación de los archivos de clase Apex de Salesforce.com

Encontré un proyecto ApexDoc en Google Code, pero está muy limitado y usa un analizador ingenuo para generar resultados en HTML. Prefiero aprovechar los analizadores y generadores de salida existentes de Doxygen que tratar de reinventar esa rueda desde cero.

lo tanto, mi pregunta:

1) nadie ha sido capaz de utilizar javadoc o Doxygen para generar documentación de la API para sus clases Apex? ¿Cómo pudiste hacerlo?

2) Me pregunto qué difícil sería escribir una secuencia de comandos simple para crear una serie de archivos .java de los archivos de clase Apex .cls, agregar declaraciones falsas import y posiblemente modificar ciertas declaraciones para mantener feliz a Doxygen. ¿Alguna idea sobre qué Doxygen (o javadoc) se está ahogando cuando intenta analizar un archivo Apex .cls?

Me sorprende que Salesforce no proporcione una herramienta de este tipo o que no haya contribuido con un analizador de Apex a javadoc/Doxygen. Su documentación y herramientas de desarrollo son extensas, y tienen una excelente configuración de prueba automatizada. No he encontrado nada de ellos para autogenerar clases.

EDITAR: Por favor, vea el updated version of this question en el Salesforce Stack Exchange.

Respuesta

1

He escrito una herramienta basada en ApexDoc. Hay una breve reseña here, con enlaces al archivo JAR y al proyecto GitHub. Por favor, déjame un comentario en mi blog si encuentras problemas.

+2

Tenga en cuenta que [las respuestas solo de enlace] (http://meta.stackoverflow.com/tags/link-only-answers/info) no se recomiendan, por lo que las respuestas deben ser el punto final de una búsqueda de una solución (frente a otra escala más de referencias, que tienden a quedar obsoletas en el tiempo). Considere agregar una sinopsis independiente aquí, manteniendo el enlace como referencia. – kleopatra

Cuestiones relacionadas