¿Cuál es la mejor manera de escribir comentarios en C?

Question

En C podemos hacer comentarios de dos maneras:

1>

/* this is one way */ 

2>

// this is 2nd way 

¿Cuál es la diferencia entre los dos?
¿Es uno mejor que el otro?

o

hacer ambas tienen el mismo impacto y no hay diferencia en la compilación o procesamiento en cualquier plataforma?

Editar: escribir código para Especialmente incrustado

Answer 1

Uno (quizás teórico) razón no utilizar // comentarios es que no están soportadas en C90. Es cierto que la mayoría, tal vez todos, los compiladores de C modernos admiten // comentarios, incluso si no son compatibles con el resto de C99, pero los diferentes compiladores admiten diferentes subconjuntos de C99.

Cualquier compilador que admita C90 rechazará (o al menos advertirá) // comentarios si lo invoca en un modo conforme a C90.

Si es un fanático de la portabilidad y desea asegurarse de que su código compila con cualquier compilador de C, entonces debe compilarlo en modo C90, lo que significa que // comentarios serán rechazados. Usted puede habilitar extensiones o cumplimiento parcial (o incluso completo) C99, pero luego habilitará otras características C99 también - y su compilador no le advertirá acerca de otras características específicas de C99 que podría usar accidentalmente.

Y como señala el comentario de Andrew Grimm, algunos proyectos pueden tener estándares de codificación que requieren una u otra forma.

Por ejemplo, gcc admite los comentarios // y long long (así como una serie de otras características de C99); Habilitando // comentarios en gcc se desactiva el diagnóstico para long long.

Pero para la mayoría de los propósitos, esto probablemente no sea motivo suficiente para evitar // comentarios. Puede escribir un código razonablemente portátil si conoce qué características son específicas de C99, qué compiladores admiten esas características y qué compiladores le interesan.

Answer 2

Sólo tiene que utilizar lo que sea más conveniente y natural. Los comentarios breves, un puñado de palabras, al final de una línea corta funcionan bien con //. Los comentarios más largos, distribuidos en varias líneas, son quizás mejores con el estilo tradicional /* ... */. Lo que sea, todo se reduce a las preferencias personales y los estándares de codificación de sus equipos.

No hace ninguna diferencia en el proceso de compilación.

Answer 3

Técnicamente, solo la primera forma está garantizada para funcionar en todos los compiladores, presentes y pasados. En la práctica, todos los compiladores de C implementados desde mediados de los años ochenta se implementan en ambos sentidos, por lo tanto, a menos que esté escribiendo para un compilador heredado, puede hacer lo que mejor funcione para usted o su organización.

Answer 4

Como dijiste: ambos tienen el mismo impacto y ninguna diferencia en la compilación o el procesamiento en cualquier plataforma.

Answer 5

1. Esta es una manera de crear fácilmente los comentarios de varias líneas
2. Sólo se puede comentar por línea usando esta forma de comentar.

Cuál es mejor es realmente una cuestión de preferencia personal, para los comentarios que abarcan múltiples líneas, usaría la primera, pero esta es mi preferencia personal.

Answer 6

/* this is one way */ 

sobre todo para utilizar este comentario de bloque y

// 

para sola línea.

Como en caso de que uno sea mejor.

// 

se garantiza que funciona con cualquier compilador.

Answer 7

Una razón para usar // comentarios podría ser si desea comentar un bloque más grande de código que tiene comentarios dentro. No puede hacer comentarios anidados con /* */.

Esto no va a compilar:

/* 

/*printf("foo");*/ 
printf("bar"); 

*/ 

Pero esto está bien:

/* 

//printf("foo"); 
printf("bar"); 

*/ 

Answer 8

Si usted tiene la necesidad de grep algo de código, tendrá ventajas con el comentario de una sola línea se utiliza para cada línea incluso si comenta un bloque (STRG + Shift + 7 en Eclipse). El código grepped donde se encontró su frase de búsqueda se visualiza CON //. El resultado no puede conducir a malentendidos debido a que no se muestran comentarios de varias líneas. resultado

1 #define MY_COUNTER 42 
2 if(MY_COUNTER == index) 
3 { 
4  tempVar = calcSomething(); 
5  doThis(); 
6 // tempVar = MY_COUNTER; 
7  doThat(); 
8 } 

grep:
1 #define MY_COUNTER 42
2 si (MY_COUNTER == índice)
6 // TempVar = MY_COUNTER;

En el código de arriba se ve directamente en el resultado grep (buscar MY_COUNTER), la línea 8 está comentada.

1 #define MY_COUNTER 42 
2 if(MY_COUNTER == index) 
3 { 
4  tempVar = calcSomething(); 
5  doThis(); 
6 /*  
7  tempVar = MY_COUNTER; 
8 */ 
9  doThat(); 
8 } 

Aquí no se puede ver el comentado línea:
1 #define MY_COUNTER 42
2 si (MY_COUNTER == índice)
7 TempVar = MY_COUNTER;