IPC

<aside> 💡 No hay una forma correcta de estilizar el código. Pero definitivamente hay muchas formas incorrectas (o, al menos, malas). Aun así, el laboratorio le pide que cumpla con las convenciones a continuación para que podamos analizar de manera confiable el estilo de su código. Del mismo modo, las empresas suelen adoptar sus propias convenciones de estilo en toda la empresa.

</aside>

Longitud de la línea

Por convención, la longitud máxima de una línea de código es de 80 caracteres en C, históricamente basada en monitores de tamaño estándar en terminales de computadora más antiguos, que podían mostrar 24 líneas verticales y 80 caracteres horizontales. Aunque la tecnología moderna ha dejado obsoleta la necesidad de mantener las líneas con un límite de 80 caracteres, sigue siendo una pauta que debe considerarse como una "parada suave", y una línea de 100 caracteres debería ser lo más largo que escriba en C, de lo contrario, los lectores generalmente necesita desplazarse. Si necesita más de 100 caracteres, puede que sea el momento de repensar los nombres de las variables o el diseño general.

// Estas siguientes líneas de código primero solicitan al usuario que proporcione dos valores enteros y luego multiplica esos dos valores enteros para que puedan usarse más adelante en el programa.
int first_collected_integer_value_from_user = get_int("Integer please: ");
int second_collected_integer_value_from_user = get_int("Another integer please: ");
int product_of_the_two_integer_values_from_user = first_collected_integer_value_from_user * second_collected_integer_value_from_user;

En otros lenguajes, particularmente en JavaScript, es significativamente más difícil restringir las líneas a una longitud máxima; allí, su objetivo debería ser dividir las líneas (como a través \n de) en ubicaciones que maximicen la legibilidad y la claridad.

Comentarios

Los comentarios hacen que el código sea más legible, no solo para otros sino también para usted, especialmente cuando pasan horas, días, semanas, meses o años entre escribir y leer su propio código. Comentar muy poco es malo. Comentar demasiado es malo. ¿Dónde está el punto dulce? Comentar cada pocas líneas de código (es decir, bloques interesantes) es una guía decente. Trate de escribir comentarios que aborden una o ambas de estas preguntas:

¿Qué hace este bloque?
¿Por qué implementé este bloque de esta manera?

Dentro de las funciones, use "comentarios en línea" y manténgalos cortos (por ejemplo, una línea), de lo contrario, será difícil distinguir los comentarios del código, incluso con resaltado de sintaxis . Coloque el comentario encima de la(s) línea(s) a las que se aplica. No es necesario escribir oraciones completas, pero escriba en mayúscula la primera palabra del comentario (a menos que sea el nombre de una función, variable o similar), y deje un espacio entre el //y el primer carácter de su comentario, como en:

// Convert Fahrenheit to Celsius
float c = 5.0 / 9.0 * (f - 32.0);

En otras palabras, no hagas esto:

//Convert Fahrenheit to Celsius
float c = 5.0 / 9.0 * (f - 32.0);

O esto:

float c = 5.0 / 9.0 * (f - 32.0); // Convert Fahrenheit to Celsius

O esto:

// convert Fahrenheit to Celsius
float c = 5.0 / 9.0 * (f - 32.0);

Encima de sus archivos .c y .h debe haber un comentario que resuma lo que hace su programa (o ese archivo en particular), como en:

// Says hello to the world

Mientras tanto, encima de cada una de sus funciones (excepto, quizás, main), debe haber un comentario que resuma lo que está haciendo su función, como en:

// Returns the square of n
int square(int n)
{
    return n * n;
}

Conditions

Las condiciones deben diseñarse de la siguiente manera:

if (x > 0)
{
    printf("x is positive\\n");
}
else if (x < 0)
{
    printf("x is negative\\n");
}
else
{
    printf("x is zero\\n");
}

Veamolo mas a detalle:

las llaves se alinean muy bien, cada una en su propia línea, dejando perfectamente claro lo que hay dentro de la rama (como si fuera un bloque de Scratch :D );
hay un solo espacio después de cada uno if;
cada llamada a printfse sangra con 4 espacios o una tabulacion;
hay espacios simples alrededor de >y alrededor de <; y
no hay ningún espacio inmediatamente después de cada (o inmediatamente antes de cada ).

Para ahorrar espacio, a algunos programadores les gusta mantener la primera llave en la misma línea que la condición misma, pero no lo recomendamos, ya que es más difícil de leer, así que no hagas esto:

if (x < 0) {
    printf("x is negative\\n");
} else if (x < 0) {
    printf("x is negative\\n");
}

Y definitivamente no hagas esto:

if (x < 0)
    {
    printf("x is negative\\n");
    }
else
    {
    printf("x is negative\\n");
    }