1
Dejar comentarios breves, de una sola línea para decir algo rápido antes de que un pequeño grupo de líneas. Comentarios Pequeño esbozo de lo que está haciendo en general " trozos ". Un programador a menudo escribir este comentario primero y volver a llenar el código después, le ayudó a cimentar su imagen mental de cómo el código funcionará antes de escribirlo , así como la identificación de las fallas en la lógica antes de escribir el código.
2
Conozca el formato para salir de los comentarios de una sola línea . Ellos se caracterizan por "//" "" //Conectar con el ServerSocket s = new TCPSocket (); s.connect . ( " Example.com " , 80) ;//Solicitar el files.write ("GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); respuesta string = s.read () ;//fue la solicitud correcta int code = get_code (respuesta ); ! if ( código = 200 ) return -1 ;//Descargar el filedownload_file ( s ) ; " "
3
Uso comentarios de varias líneas cuando usted tiene más que decir de los que caben en una sola línea. Comentarios de varias líneas se encuentran generalmente en la parte superior de los métodos que describen la función global , cómo funciona y qué parámetros se necesita . También son a veces vistos en partes localizadas del código que el programador tenía problemas con o piensa orden de un debate a fondo .
4
Observe el formato general de los comentarios multilínea. Por convención , cada línea comienza con un asterisco. Los únicos requisitos específicos de formato es que el comentario comienza con /* y termina con * /. "" /* Esta parte fue muy duro. Tuve que * hackear este valor para adaptarse a los demás. * Tal vez voy a volver a este código para encontrar * una mejor manera de hacer esto, pero por ahora * esto funciona, pero no es bastante . * /""
5
conocer el formato de los comentarios Javadoc . Ellos comienzan con /** y contienen meta-tags que se parecen a @ esto. Comentarios Javadoc se encuentran principalmente antes de los métodos . "" /*** Calcula la pendiente de una línea. ** @ Autor Jack Smith * @ param p1 Primer punto que describe la línea * @ param P2 Segundo punto que describe la línea * @ Pendiente retorno de la línea como un float * /" "