Pregunta breve: ¿Es posible crear Javadoc para variables locales? (Solo quiero una explicación para mi variable local al pasar sobre ella en Eclipse) Gracias por cualquier sugerencia :-)Javadoc para variables locales?
Respuesta
La variable local debe declararse unas líneas arriba de su uso. Simplemente use comentarios regulares si es necesario. Pero lo más importante es mantener los métodos cortos, elegir nombres significativos para ellos y declararlos solo cuando los necesite. La mayoría de las veces, es completamente innecesario comentar las variables locales.
Prefiero
int numberOfBooks = books.size();
sobre
// the number of books
int n;
... // 50 lines of code
n = books.size();
Acepto que es innecesario * la mayor parte del tiempo *, pero hay cosas que son más complejas de explicar que la cantidad de libros y cosas así, especialmente cuando se hacen cálculos más complejos, etc. –
No, no es compatible, ya la generación de JavaDoc lo ignorará.
Sí, es posible. Simplemente haga un comentario regular de javadoc sobre la variable.
public class ExampleClass {
/** A really cool variable */
int localVariable;
...
Ahora puede pasar el cursor sobre la variable en el código más abajo y se mostrará el comentario.
Se puede hacer usando Annotations
.
Crear un simple tipo de anotación como las siguientes:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
String value();
}
y utilizarlo en su variable local:
@LocalVariableDocumentation("A very important object!")
Object anImportantObject;
Eclipse mostrará la anotación en la descripción.
Gran solución, ¿por qué esta respuesta no es aceptada? – Ced
La única forma en que es posible es con variables globales. Las variables locales no pueden anotarse con JavaDoc.
Sólo hacer un enlace a su variable local
String someLocalVariable;
/**
* This a local variable: {@link #someLocalVariable}
*/
Esto no funciona en Eclipse Mars, ¿o sí? – Ced
- 1. Variables locales en java
- 2. empujar variables locales
- 3. referencia colapso para las variables locales
- 4. Variables locales estáticas para métodos en Ruby?
- 5. variables de sesión vs variables locales
- 6. Imprimir todas las variables globales/variables locales?
- 7. acceso todas las variables locales
- 8. bloques, bucles y variables locales
- 9. C++ variables locales seguras multiproceso?
- 10. Distinguir cierre y variables locales
- 11. setjmp/longjmp y variables locales
- 12. SQL CASE y variables locales
- 13. Javadoc múltiples variables en una sola línea
- 14. ¿Cómo se definen las variables estáticas locales locales de subprocesos?
- 15. Valores predeterminados de variables de instancia y variables locales
- 16. Variables de instancia de Java contra variables locales
- 17. ¿Cuándo se asigna espacio de pila para las variables locales?
- 18. Node.js - Establecer variables locales predeterminadas para pasar al diseño/plantilla
- 19. Java ¿cómo imprimir todas las variables locales?
- 20. Carriles - Variables locales frente a variables de instancia
- 21. Cómo acceder a las variables locales dinámicas
- 22. Uso de variables locales implícitamente mecanografiadas
- 23. las variables Constructor-locales en Scala
- 24. Prevenir .NET de "lifting" variables locales
- 25. Acceso global frente a variables locales
- 26. sincronizados y locales copias de las variables
- 27. ¿JavaScript no admite cierres con variables locales?
- 28. Variables locales en bash: local vs subshell
- 29. ¿Cómo usar variables locales en procedimientos almacenados?
- 30. variables estáticas locales y globales en C++
Puede incluir descripción de la variable en el comentario de JavaDoc método –
En algún momento cuando se tiene que depurar un código de otra persona y las variables locales son sucios, ayudaría. – Ced