Buenas prácticas de programación
Hola.
Me gustaría poder controlar la calidad del código fuente que, o bien creamos en la empresa, o bien subcontratamos.
Mi idea es poder descargar del repositorio de código (usando cvs o svn) los ficheros que se han añadido / modificado y comprobar si siguen una serie de criterios de buenas practicas de programación.
Los criterios que, de momento, se me ocurren son :
* Tamaño del fichero. Si se meten miles de lineas en un solo fichero, éste se convierte en ilegible.
* Tamaño de las funciones. Cuando estudiaba se decía que una función no debería ser mayor que el tamaño de la pantalla. Así que una función con mas de x lineas seria un criterio.
* Ratio mínimo de comentarios. Debería haber un ratio lineas_de_comentario / lineas_totales mínimo. Estos comentarios deberían de ser útiles, ya que hace años traté de instaurar un estilo de comentarios parecido al javadoc y 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.
* Comentarios en funciones. Si una función tiene mas de x lineas entonces es compleja y debería de tener en su cabecera un comentario explicando el funcionamiento.
Estas son las que se me han ocurrido. Si alguien tiene algún otro criterio o alguna idea le agradeceré mucho su comentario.
Por cierto, los lenguajes a tratar serían Delphi, Java, C# y ASP.
Saludos
|