Buenas prácticas de programación

[roman]

Empezado por razonasistemas

me encontré con que la gente ponía como comentarios en un button.click, por ejemplo "@param sender componente que activa el evento" o "@return no se devuelven resultados" o sea, comentarios sin ningún valor.

Pues hombre, tanto como sin ningún valor...

Los comentarios en javadoc tienen un formato muy específico, y uno de los requerimientos es el de especificar los parámetros y valor devuelto por cada método.

Toma en cuenta que tales comentarios se usan para generar documentación en automático. Si ves un listado de los métodos de una clase en un contexto ajeno al código en sí, puede resultar muy útil saber a primera vista qué parámetros recibe un método y si devuelve o no un valor.

Y, dado que este tipo de consideraciones son útiles para generar documentación, no es descabellado que parte de tus criterios de calidad del código fuente incluya el uso sistemático de comentarios de ese tipo.

// Saludos