Cómo escribir código C de alta calidad
1. El código que escribimos es para que otros lo vean, por lo que al principio del código debemos declarar para qué sirve este programa, quién es el autor, así como el número de versión y el historial de modificaciones. , así como el nombre del modificador. El nombre y la fecha de finalización lo dejan claro a los demás. Este es un ejemplo mío:
2. Uso de archivos de encabezado:
1. Primero, hablemos de la función de los archivos de encabezado: llamar a funciones de biblioteca y fortalecer las comprobaciones de seguridad de tipos.
2. Para evitar que se haga referencia repetidamente a los archivos de encabezado, se debe utilizar la estructura ifndef/define/endif para generar bloques de preprocesamiento.
3. El formato #include
4. Es mejor no utilizar variables globales en el archivo de encabezado y evitar declaraciones como el valor int externo.
5. Los archivos de encabezado se colocan en un directorio y los archivos de definición se colocan en otro directorio. Es mejor separarlos así.
3. Procedimientos específicos:
1. Líneas en blanco
Un buen diseño del programa requiere agregar líneas en blanco después del final de cada función. En el cuerpo, las declaraciones lógicamente estrechamente relacionadas no utilizan líneas en blanco y otros lugares están separados por líneas en blanco.
[cpp]?ver plano?copia
void?fun()
{?
...;
}
//Línea vacía
void?fun1()
{
mientras?(1);
{
...;
//Línea vacía
si?(...)
{
...;
}
}
}?
//¿Línea vacía?
2. Línea de código
Una línea de código solo hace una cosa, definir una variable o una declaración. Lo mejor es inicializar la variable mientras la define;
Si, for, while, do y otras declaraciones ocupan una línea, no importa cuán larga sea la declaración de ejecución, recuerde agregar '{', '}'.
[cpp]?vista simple?copia
int?a=1;?
int?b=2;?
int?c=a+b;?
si?(..)?
{?
....;?
}?
//¿Línea vacía?
other();?
3. Espacios dentro de líneas de código
Palabras clave Deje un espacio después y deje un espacio después de palabras clave como if y for, seguido de paréntesis;
No se dejan espacios para ",", "(", ")" y ";" que siguen inmediatamente adelante;
p>
", "Deja un espacio después", "Si no es el terminador de una línea, deja un espacio después de ella
Los operadores y otros operadores binarios van precedidos y seguidos de espacios, y los operadores unarios no van precedidos ni seguidos de espacios. No agregue espacios antes y después de "[ ]", "." y "->". /p>
Para expresiones más largas, algunos espacios se pueden eliminar adecuadamente.
[cpp]?ver plano?copia
void?fun(int?a?,int?b,?int?c);?
[ cpp]?ver plano?copiar
si?(año?>=?2000)?
[cpp]?ver plano?copiar
si?( (a>=b)?&&?(c<=d))?
[cpp]?ver plano?copia
para?(i=0?;?i< 10;?i++)?
[cpp]?vista simple?copia
matriz[2]?=?0;?
[cpp]?vista Plain?copy
int?*x?=?&y;?
4. Alineación
"{", "}" ocupan una fila y están en la misma columna Alineación, alineada a la izquierda con las declaraciones que hacen referencia a ellas, y los bloques de código entre paréntesis están alineados a la izquierda. Los corchetes anidados están sangrados y alineados.
[cpp]?ver plano?copia
void?fun(int?x)?
{?
... ..;?
}?
¿para?(...)?
{?
....;?
}?
[cpp]?ver simple?copiar
[cpp]?ver simple?copiar
{? p>
[cpp]?ver plano?copiar
{?
[cpp]?ver plano?copiar
...;?
[cpp]?ver plano?copiar
}?
[cpp]?ver plano?copiar
[cpp]?ver simple?copia
}?
5. División de líneas largas
La longitud máxima de la línea de código se controla entre 70 y 80 caracteres, lo cual es conveniente para visualización e impresión de expresiones largas se dividen en nuevas líneas en operadores de baja prioridad, y los operadores se colocan al principio de la nueva línea y se les aplica la sangría adecuada
[cpp]?view Plain?copy
si?((a1?>=?a2)?
&&?(a3?>=?a4)?
&&?(a5?>=?a6 ))?
int?main(a1,?
a2);?
para?(long;?
medio; ?
p>corto)?
6. La posición del modificador
* y & están al lado del nombre de la variable
7. Comentar, el símbolo del comentario es / *... */, //, #if 0, #endif
Los comentarios deben ser pocos y precisos, y no deben ser abrumadores. Su función es ayudar. comprender el código;
Escribir código mientras se escribe Usar comentarios laterales para garantizar la coherencia, evitar la ambigüedad y utilizar abreviaturas poco comunes en los comentarios;
Cuando el código es largo o tiene múltiples anidamientos, los comentarios Debe añadirse al final del párrafo para facilitar la lectura.