Los comentarios son una herramienta poderosa. Pueden ser utilizados para generar toda la interfaz de programación de aplicaciones (API) documentaciones con herramientas como javadoc, dar pequeños toques en partes difíciles de código, o simplemente describir lo que el código está a punto de hacer. Al salir de los comentarios en el código de Java, también puede mostrar un lector que no conoce el idioma exactamente lo que el código está haciendo.
Instrucciones
1 Deja, breves comentarios de una sola línea para decir algo rápidamente antes de que un pequeño grupo de líneas. Pequeñas esquema de comentarios lo que se hace en general "trozos". Un programador a menudo escribir este comentario primero y volver a rellenar el código después, lo que ayuda a consolidar su imagen mental de cómo el código funcionará antes de escribirlo, así como para identificar cualquier defecto en la lógica antes de escribir el código.
2 Conocer el formato para dejar comentarios de una sola línea. Se caracterizan por "//". ""// Connect to the server
Socket s = new TCPSocket();
s.connect("example.com", 80);// Request the file
s.write("GET / HTTP/1.0\r\n\r\n");
string response = s.read();// Was the request successful?
int code = get_code(response);
if( code != 200 ) return -1;// Download the file
download_file(s);""""// Connect to the server
Socket s = new TCPSocket();
s.connect("example.com", 80);// Request the file
s.write("GET / HTTP/1.0\r\n\r\n");
string response = s.read();// Was the request successful?
int code = get_code(response);
if( code != 200 ) return -1;// Download the file
download_file(s);""
3 Utilice comentarios de varias líneas cuando se tiene más que decir de los que caben en una sola línea. los 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 están a veces se aprecia en partes localizadas de código que el programador tenía problemas con o piensa orden de discusión en profundidad.
4 Tenga en cuenta el formato general de los comentarios multilínea. Por convención, cada línea comienza con un asterisco. Los únicos requisitos específicos del formato son que el comentario comienza con /
y termina con /. ""/ This part was really tough. I had to
hack this value to fit with the others.
Maybe I'll come back to this code to
find a better way to do this, but for
now this works, but it's not pretty.
/""""/ This part was really tough. I had to
hack this value to fit with the others.
Maybe I'll come back to this code to
find a better way to do this, but for
now this works, but it's not pretty.
/""
5 Conocer el formato de los comentarios Javadoc. Comienzan con / y contienen meta-tags que se parecen a @este. Comentarios Javadoc se encuentran principalmente antes de métodos.
""/
Calcula la pendiente de una recta.
@author Jack Smith
@param P1 Primer punto que describe la línea
@param segundo punto P2 que describe la línea
Pendiente @return de la línea como un flotador
* / ""
Consejos y advertencias
- Desarrollar un balance de los comentarios al escribir el código. Demasiados comentarios realidad hace que el código sea más difícil de leer. Cuando el código es fácil de seguir, no tiene sentido por escrito los comentarios para cada línea. En el otro extremo, con el código no tiene comentarios puede ser difícil de leer si el lector no entiende completamente lo que el código está haciendo.
- En Java, también verá javadoc meta-tags en los comentarios multilínea.