class: center, middle, inverse # Documentació del programari ### JavaDoc .footnote[Joan Puigcerver Ibáñez] --- layout: true class: regular-slide .right[.logo[]] --- # Documentació del programari Documentar el codi d'un programa és dotar el programari de tota la informació que sigui necessària per explicar el que fa. Els desenvolupadors que duen a terme el programari (i la resta de l'equip de treball) han d'entendre què està fent el codi i el perquè. --- # Documentació del programari - Codi - Comentaris interns - Documentació externa --- # El codi com a documentació - Un codi ben fet és la primera part de la documentació - Ordre - Noms de variables, mètodes i classes - Longitud dels mètodes - ... - No evita fer altres documentacions --- # Javadoc - Format de documentació Java que ens permet documentar mètodes i classes - Pot generar una documentació externa - [javadoc de String](https://docs.oracle.com/javase/7/docs/api/java/lang/String.html) --- # Javadoc ### Format ``` /** * Comentari Javadoc */ ``` --- # Javadoc ### Classes ``` /** * Aquí s'hi ha de posar informació descriptiva de la classe */ public class SampleClass { } ``` --- # Javadoc ### funcions ``` /** * Calculates the area of a rectangle * @param height of the rectangle * @param width of the rectangle * @return area of a rectangle of the given width and height */ public static int rectangleArea(double height, double width){ return height * width; } ``` --- # Javadoc - @author nom - @version versió - @param pàmetre descripció - @return descripció - @exception nom descripció - @see referència - @deprecated comentari --- # Javadoc ### IntellIj "/**" + Enter