javadoc

6El calor

5Respuesta

Cómo documentar getters y setters

Para getters/setters simples, como el siguiente, ¿cuál es la mejor manera de documentarlo? public float getPrice() { return price; } estoy bastante estricto en cuanto a los estándares de codi

language-agnostic documentation coding-style javadoc 2010-08-30

---

28El calor

2Respuesta

¿Cómo se puede copiar el Javadoc de un método en el Javadoc de otro método?

Sé que hay @inheritDoc, pero es solo para métodos que anulan otros. Tengo varias clases con muchos delegado métodos (que hacen no invalidación otros). ¿Puede su Javadoc ser "heredado" (más exactamente

java javadoc delegation 2010-09-01

---

21El calor

3Respuesta

Grails: Alternativas al Doc Grails?

La documentación creada al ejecutar grails doc no es del todo satisfactoria para mí. Por ejemplo, las acciones en los controladores aparecen como propiedades en la documentación, aunque me gustaría te

grails documentation javadoc documentation-generation 2010-09-03

---

211El calor

1Respuesta

Javadoc: package.html o package-info.java

Al intentar crear comentarios de Javadoc a nivel de paquete, ¿cuál es el método preferido? ¿Qué haces? package-info.java Pros reciente Contras Abuso de una clase - Las clases son para el código, no só

java javadoc 2010-09-05

---

6El calor

2Respuesta

¿Documentación similar a Javadoc para bibliotecas C/C++?

¿Hay algo así como la documentación de tipo Javadoc disponible para las bibliotecas C/C++?

c javadoc 2010-09-05

---

38El calor

7Respuesta

¿Cómo agregar comentarios a nivel de paquete en Javadoc?

Estoy usando Check-Style, FindBugs y PMD para validar mi código de Java. He solucionado casi todos los errores capturados por estas herramientas. No puedo entender cómo escribir "package comment", que

java documentation comments javadoc 2010-09-06

---

11El calor

5Respuesta

¿La gestión de código fuente hace que @author y @since de Javadoc sean redundantes?

En la mayoría de los equipos hay una regla que dice que las palabras clave @author y @since deben usarse para todas las clases documentadas, a veces incluso para los métodos. En un intento de centrarm

java version-control javadoc 2010-09-16

---

6El calor

1Respuesta

Cómo usar javadoc: ¿se agrega correctamente en el proyecto maven de varios módulos?

Este es mi archivo principal pom.xml (parte de ella) en un proyecto de varios módulos: ... <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>

maven-2 javadoc 2010-08-04

---

5El calor

2Respuesta

Java threading JavaDoc

He escrito un método que solo debe invocarse en un hilo en particular. ¿Hay una anotación o nota estándar que se debería agregar al javadoc del método para denotar esto?

java multithreading thread-safety javadoc 2010-09-23

---

5El calor

2Respuesta

Etiqueta @since javadoc automática para las versiones

¿Existe alguna herramienta para agregar automáticamente la etiqueta @since a todos los elementos cuando deseo tener una versión de lanzamiento? Así que vamos a decir que tengo un montón de métodos y m

java javadoc documentation-generation 2010-08-05

---