Tabla de contenido
La vista en modo de documentación agrega automáticamente alguna información que está en los
comentarios de documentación. Primero está la línea de información del objeto, el cual es una lista de
las declaraciones del método público del objeto incluyendo el nombre del método, lista de parámetros
y valores de regreso. Esto le da al programador una vista d los métodos del objeto. Con esto en mente
es importante escoger nombres descriptivos para un método de objeto, parámetros de método y
valores de regreso. El modo de documentación también proporciona cuanta memoria agregara el
objeto a un programa y cuanto toma para las variables. Estas por supuesto son importantes para
características de vista rápida.
El modo de vista de documentación también inserta cada declaración de método (sin variables locales
no se usan como parámetros o variables de regreso). Note como también aparecen los comentarios de
documentación debajo de la declaración del método y lo que hace el método, que información
deberán recibir sus parámetros y que regresar. Cada documentación de método público deberá tener
suficiente información para un programador sin tener que mover de regreso a la vista completa y
hacer ingenieria inversa al método y tratar de adivinar que es lo que hace. Esta es otra buena razón
para escoger los nombres de métodos y parámetros cuidadosamente ya que ayudara a hacer los
comentarios más concisos. Con los comentarios de documentación debajo de cada declaración de
método público explique qué hace el método. Explique cada parámetro, empiece con su nombre e
incluya cualquier información adicional acerca de los valores que el parámetro tiene que recibir. Haga
lo mismo para valores de regreso.
Intente agregar un comentario de documentación de bloque justo abajo del método
ButtonBlinkTime
debajo de la declaración del método en el modo de vista de documentación.
del objeto CogObjectExample y verifique que la documentación aparece
Kit Educativo de Practicas Propeller: Fundamentos · Página 93
6: Práctica de Objetos
Figura 6-5: Vista de Documentación
Figura 6-6: Mas vista de documentación
Tabla de contenido
