Articles of javadoc

Qué hacer con Javadoc de terceros

¿Desea ver qué hacen los demás con los documentos java de terceros (proveedores)? ¿Se colocan bajo el control de la fuente para que todos puedan tener acceso a ellos? ¿Colocado en un directory compartido local? otras soluciones que las personas tienen que funcionar bien. Usamos clearcase y tenemos desarrolladores distribuidos por los EE. UU. Junto […]

Pros y contras de versionar javadoc

Me pregunto si debo o no enviar files Javadoc al repository SVN de mi proyecto. He leído acerca de las buenas prácticas de SVN, incluidas varias preguntas interesantes sobre SO, pero ya no se me ha preguntado ninguna sobre el event handling javadoc. Al principio estaba de acuerdo con los arguments de que solo el […]

Elimine el comentario "Generado por Javadoc en <date> <hora>" en Javadoc generado

Un command javadoc inserta automáticamente un comentario que dice algo así como: <!– Generated by javadoc (build 1.6.0_17) on Thu Apr 07 18:32:31 CEST 2011 –> en cada file HTML generado. Esto está evitando bastante el seguimiento de cambios para javadoc con versiones, ya que cada file se modificará al regenerar el documento. Una pregunta […]

¿La administración del código fuente hace que @author y @since de Javadoc sean networkingundantes?

En la mayoría de los equipos hay una regla que dice que las palabras key @author y @since deben usarse para todas las classs documentadas, a veces incluso para los methods. En un bash de centrarme en lo que importa, no utilizo estas palabras key y me baso en el hecho de que puedo usar […]

¿Por qué maven ejecuta el mismo pom de manera diferente en dos computadoras?

Mi compañero de trabajo y yo estamos tratando de llamar al mismo command Maven (sitio mvn) exactamente en el mismo pom y obteniendo resultados totalmente diferentes . El código del que creemos que está yendo mal es el javadoc-plugin que agregamos últimamente: <!– https://maven.apache.org/plugins/maven-javadoc-plugin/ –> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>${version.javadoc.plugin}</version> <configuration> <destDir>javadoc</destDir> <charset>UTF-8</charset> <docencoding>UTF-8</docencoding> <doctitle>${project.name} API […]

Palabra key de Subversion para nombre de file

Fondo El cliente solicita que todos los files fuente incluyan lo siguiente en el encabezado: File: filename.ext Problema Por lo que puedo decir, Subversion ofrece las siguientes palabras key : Carné de identidad Rdo Revisión Fecha LastChangedDate LastChangedRevision Autor LastChangedBy HeadURL URL De esas palabras key que contienen el nombre del file, todas contienen más […]

Genera javadoc directamente desde el repository?

¿Hay alguna manera de generar un Javadoc directamente desde un repository SVN? (¿o necesito verificar el código?)

¿Cómo crear Javadoc en el server de destino (SVN-) usando Maven?

Quiero crear los files Javadoc de mi proyecto en el server SVN justo después de haberlo confirmado, lo que significa que quiero que el server haga el trabajo . Ya busqué en la sección de ejemplos de maven–javadoc-plugin , pero no pude encontrar una solución adecuada. (Tal vez simplemente no lo entendí, soy nuevo para […]

¿Hay alguna manera de validar la presencia de Javadoc y / o comentarios de código en línea?

Estamos tratando de implementar processs de código de calidad para un gran proyecto en el que estoy trabajando. En este momento, muchos desarrolladores no están incorporando comentarios de código Javadoc o en línea en su código. Ok ahora mismo. Pero nos lastimará severamente en un futuro muy cercano. Estamos utilizando Maven 2.0.9 como nuestra herramienta […]

Maven, Subversion, Javadocs

¿Hay alguna forma de modificar Javadocs @version value y agregar el número de revisión del file automáticamente en el repository SVN? plantilla de ejemplo @version $ v rev. $ rev y salida @version v2.1 rev. 74321 actualización: quiero agregar numbers de revisión y "tal vez" si fuera posible, nombres de label como versiones