En mi opinión, los casos de prueba de la unidad en sí sirven como documentación para el código. Mi empresa quiere que escriba comentarios detallados de java doc sobre los casos de prueba de unidad. ¿Es necesario hacerlo? ¿Escribes comentarios como ese?
unit-testing
documentation
Vinoth Kumar CM
fuente
fuente
Respuestas:
Lo que hago es JAVADOC-comment:
la clase, que indica qué clase se prueba por unidad (aunque debería ser obvio ya que la mejor práctica sobre ese tema sugiere que el nombre del caso de prueba debería ser el nombre de la clase + "Prueba" o + "TestCase"). Esto se hace utilizando el comentario de {@link XXXClass} JAVADOC
los métodos, que indican qué método se prueba ({@link XXXClass # method1}). A veces necesito tener múltiples métodos de prueba para un método de una clase para probar adecuadamente todas las rutas. Cuando sucede, escribo una línea adicional que indica qué ruta estoy probando dentro (pero nunca me desvío de mi convención de una línea)
Aparte de eso, no hay otro comentario. Para llamar su atención en otro lugar, tal vez podría usar algo como Cobertura para generar gráficos bonitos de cobertura de código y hacerlos felices de esa manera :-)
Nota adicional: me estoy refiriendo a los casos de prueba de unidad, si estamos hablando de casos de prueba de integración, entonces una o dos líneas más para explicar lo que está sucediendo pueden ser necesarias ...
fuente
Los requisitos de documentación para cualquier código están completamente cubiertos en las respuestas a esta pregunta: mi jefe quiere una explicación narrada en línea línea por línea de nuestro código
Como resumen de las respuestas que verá allí, "Depende de su situación". Hay casos en los que es razonable (y alentado), y otros en los que es una pérdida de tiempo.
fuente
Los comentarios Javadoc se pueden extraer y formatear en un documento de referencia separado, las pruebas unitarias no. Además, tenga en cuenta que lo que escribe en palabras puede ser diferente del código real, y generalmente está describiendo en palabras el comportamiento real esperado. Una de las formas de encontrar errores es comparar la documentación con el código real, si no coinciden, es un error (en cualquiera de ellos y, a veces, en ambos).
La prueba unitaria es para pruebas, no para documentación. Usar la prueba unitaria como documentación es incorrecta y no debe hacerse.
fuente