Descripción de funciones
Descripción de funciones
> Tutorial de LeekScript
Desde la versión 2.17, ahora puede documentar sus funciones utilizando la notación Javadoc.
Para qué ?
Es importante comentar tu código. Esto ayuda a describir las funciones, clases y métodos que usa en su código. Esto hace que sea más fácil volver a partes del código en las que no ha trabajado en mucho tiempo y es una buena práctica cuando se trabaja en equipo.
Como hacer ?
La notación de JavaDoc es muy simple. ¡El de Leek Wars es aún más simple! Solo necesitas saber tres palabras clave:
@param: Usado para describir un parámetro@return: Se utiliza para describir el retorno de la función@version: Se usa para dar la versión de la función
La notación JavaDoc se realiza de la siguiente manera:
Un JavaDoc se escribe en un comentario en varias líneas usando la notación /* */.