Si un "ejemplo" puede valer más que mil palabras, un programador de una "revisión" puede estar horas y horas de trabajo! Comenta el código suele ser tedioso y, en el momento de escribir el código, siempre parece un inútil. Por el contrario, máxime si tenemos los viejos códigos, después de haber acaba de entrar en los comentarios pueden ser infinitamente útil para reconstruir los caminos mentales han sido olvidados. Afortunadamente, para aquellos como yo que ha desarrollado la web, tiene la enorme vatanggio puedo opinar sobre casi todo el código de la misma manera! La doble barra (/ /) o barra de contención a través de asterisco y barra asterisco (/ * y / *) con el apoyo de casi todo el desarrollo lunguaggi de uso común, casi todos derivados de la carpeta C: JavaScript, ActionScript, PHP, ...
Como encabezado, por ejemplo, yo siempre uso una estructura de este tipo, el mismo para casi todos los lenguajes que utilizamos:
1 2 3 4 5 6 7 8 9 | / * @ ** Nombre: main.as @ ** Descripción: la clase principal del proyecto de Flash @ ** Autor: = undo = @ ** Web: http://www.undolog.com @ ** E-mail: @ g.fazioli undolog.com - g (punto) Fazioli (a) undolog (punto) com ** @ ** Versión: 1.0 * / |
la sintaxis misma también puede ser utilizado para Javascript o PHP. El uso del símbolo @ (arroba), el caracol, con el fin de realizar un seguimiento de los comentarios dentro del código de forma rápida, ultile para comentarios de las funciones (métodos), eventos y propiedades:
1 2 3 4 5 6 7 8 | / * @ ** Nombre: minimizar () @ ** Descripción: genera un tipo de análisis @ ** Params: valor: valor de un colapso **: Tipo - Tipo del colapso @ ** Resultado: true si bien, false si el error ** @ SeeAlso: uncollapse () * / |
En ActionScript, donde se ha más a menudo frente a las clases, los métodos para distinguir entre (público o privado), eventos y propiedades puede ser útil durante el curso de la aprobación de un código:
1 2 3 4 5 | / * @ ** Nombre: ontopdown () @ ** Descripción: (evento) - trigged cuando el elemento está activo ** @ SeeAlso: ontopup () * / |
1 2 3 4 5 | / * @ ** Nombre: Color @ ** Descripción: (propiedad) - obtiene / asigna el color de fondo ** @ SeeAlso: bgcolor * / |
Es cierto, yo diría que, además de ayudarte a ti mismo en la lectura del código, también ayudará a aquellos que vengan después de usted (si usted trabaja en proyectos comunes). En este caso, también se convierte en una forma de respeto, dejar un buen trabajo en las manos de otros hace la vida más fácil para los demás.
En alguna parte leí una cita de alguien que dijo Inglés "del programa como uno que viene después de que fuera un psicópata que sabe dónde vives"
@ Chris: santas palabras!