Hola y bienvenido de nuevo.
Estamos comenzando una nueva sección.
Y en esta sección, quiero hablar sobre algunos de los conceptos básicos en C.
Quiero describir algunas de las cosas que tuvimos en nuestro ejemplo o nuestro primer desafío,
nuestro programa principal aquí.
Así que tengo este desafío, probablemente lo recuerdes.
Tiene varias declaraciones diferentes en líneas de código.
Voy a tratar de cubrir algunos de los conceptos aquí. Voy a ir y venir a este ejemplo.
Lo primero que quiero discutir es el concepto de comentario.
Así que volveremos a esto en un segundo. Quiero ir a algunas diapositivas en este momento.
Por tanto, los comentarios se utilizan en un programa para documentar un programa
y mejorar su legibilidad.
Le dije por qué es importante que su programa sea legible.
Porque mantendrá el código y necesita poder verlo y comprender
lo que está haciendo. Entonces, con los comentarios,
puede ayudar
bastante en este concepto de legibilidad.
Los comentarios están ahí para recordarle a usted oa otra persona que lea
su código qué está haciendo el programa o qué está haciendo una línea de código en particular.
Entonces, los comentarios están ahí para su beneficio.
El compilador ignora los comentarios.
Por lo tanto, no importa si sigue la sintaxis de los comentarios, el compilador no arrojará
ningún error, sea lo que sea que esté dentro del comentario.
De nuevo, son muy útiles y desea utilizarlos en sus programas.
Y son un concepto básico de todos los lenguajes de programación.
Así que no hay nada nuevo que ver aquí.
Una vez más, como programador, puede escribir algún código, volver a él en 6
meses y es posible que no recuerde
por qué escribió el código de la forma en que lo hizo.
Es posible que no comprenda la funcionalidad, es posible que no comprenda la lógica.
Al proporcionar un comentario en el código,
puede ahorrar una cantidad significativa de tiempo que pierde en volver a aprender cosas, especialmente
en volver a aprender ese código.
O imagina que escribiste un
código y es un programa grande, hay muchos programadores trabajando en él
y alguien más necesita mirar ese código.
Si hay comentarios y están describiendo lo que está haciendo el código,
entonces esa otra persona podrá entender ese código mucho más rápido.
Será más legible. Entonces, nuevamente, los comentarios ayudan a la legibilidad,
ya sea ayudan a la legibilidad del programador que escribió el código o ayudan
a la legibilidad de alguien más que está mirando el código.
Puede mirar fácilmente ese código fuente y luego comprender rápidamente qué está haciendo el código.
Y entonces desea proporcionar comentarios en su código.
La sintaxis para proporcionar comentarios en su código es que
hay 2 formas en que puede proporcionar comentarios en su código.
Y nuevamente, esto es muy, muy similar a Java, muy similar a muchos lenguajes.
Pero en c, puede tener comentarios de varias líneas o comentarios únicos.
Si usa 2 caracteres, la barra inclinada seguida de un asterisco,
esto significará un comentario de varias líneas, un comentario que
se extiende por muchas líneas.
Y la estrella de barra inclinada hacia adelante marca el comienzo de ese comentario.
Y cuando tienes estos comentarios de varias líneas porque tienen un comentario
inicial, tienes que tener algo que diga que termina.
Entonces, para finalizar los comentarios, coloque los caracteres como asterisco y
barra diagonal al final sin espacios entre ellos.
Entonces, cualquier cosa entre la estrella con barra inclinada hacia
adelante y la barra inclinada hacia adelante de la
estrella final se considera un
comentario, todo en azul eso. Y de esa manera puede abarcar varias líneas.
La otra forma en que puede agregar un comentario a su programa c es usar comentarios
de una sola línea.
Los comentarios de una sola línea son solo 2 barras diagonales.
Cualquier cosa después de las 2 barras diagonales en esa línea es
ignorada por el compilador y se considera un comentario.
Cualquier cosa después de eso no es un comentario, es una nueva línea de código.
Por lo tanto, realmente depende
del comentario que proporcione si desea o no utilizar comentarios de varias líneas o comentarios de una sola línea.
Y te mostraré cómo puedes agregarlos a tu código en un segundo.
Ahora, en lo que respecta al estilo, ya sea que use comentarios de varias líneas
o comentarios de una sola línea, probablemente usará ambos según lo que esté tratando de hacer
o cuántas líneas tenga que describir o qué tan grande sea su comentario.
En este ejemplo, estamos usando un comentario de varias líneas aquí, y esto normalmente
iría en la parte superior del archivo. Describe quién escribió el archivo,
el autor del archivo y luego los derechos de autor.
También puede proporcionar comentarios que se destaquen si
algo realmente importante en su código está
sucediendo proporcionando muchos asteriscos.
Entonces, el segundo ejemplo aquí donde dice que este es un comentario muy
importante, realmente se destaca por todos esos asteriscos.
Por lo tanto, es un estilo diferente al del comentario de encabezado en la parte
superior del primer ejemplo.
Ahora, el último ejemplo aquí, que es solo un comentario de una sola línea,
está al final de una línea de código y básicamente te dice lo que está haciendo una sola línea.
Entonces ves estos estilos diferentes de comentarios de varias líneas en comparación con comentarios de una sola línea.
Este es un ejemplo común que vería en un programa.
Este es un programa que contiene código C.
Probablemente no sepa realmente qué diablos está haciendo esto.
Pero puedes mirar los comentarios e identificar lo que está pasando.
Entonces, hay un comentario en la parte superior que dice que este programa agrega 2 valores enteros y muestra los resultados.
Le dice el propósito del programa, lo
que está haciendo.
Y luego ves algunos comentarios de una sola línea.
¿Y cómo sabes que son comentarios de una sola línea? Porque tienen 2 barras diagonales.
Entonces verá un comentario de una sola línea que dice declarar variables.
Verá otro que dice asignar valores y calcular su suma.
Y luego ves uno que dice mostrar el resultado.
Cada comentario de una sola línea describe cada grupo de código y le dice lo
que están haciendo.
Y para que pueda ver rápidamente
este código y comprender lo que hace el código mirando los comentarios.
Hace que el programa sea más legible.
La legibilidad es una ventaja porque facilita el mantenimiento del código.
Por eso es importante utilizar comentarios. Y este es un ejemplo rápido de
cómo agregar comentarios a algún código.
Ahora, ¿con qué frecuencia debemos utilizar los comentarios?
Existe el concepto de tener demasiados comentarios.
No desea que su código tenga un comentario para cada línea.
Eso en realidad disminuye la legibilidad del código porque está desbordado.
En realidad, lo hace más difícil de leer porque es abrumador.
Por lo tanto, no desea poner un comentario para cada línea de código.
Tienes que elegir sabiamente tus comentarios y usarlos inteligentemente.
Esto vendrá con la práctica, cuándo agregar
comentarios, cuándo no agregar comentarios, dónde colocar los comentarios.
Por lo general, tendré comentarios en la parte superior de
mi archivo fuente con información estándar como el autor, el propósito, la descripción,
la fecha de creación de los comentarios, luego intercalados a lo largo de mi código,
describiendo algunas líneas de código donde está la lógica un poco más complicado.
No siempre incluiré comentarios solo para declarar variables porque es algo obvio.
Es posible que no incluya comentarios para ciertas funciones, descripciones porque
la descripción en sí misma podría ser más significativa.
Todo depende y viene con la práctica.
Pero siempre que agrega comentarios, tradicionalmente es una buena idea agregar
esos comentarios cuando está escribiendo el código.
Uno porque si lo haces entonces, tendrás el programa comentado y no
te olvidarás de hacerlo.
También es más fácil documentar el programa por qué
realmente comprende lo que está haciendo mientras escribe el código.
Aún fresco en su mente, no tiene que volver un mes
después y decir qué quise decir aquí y ahora tengo que agregar un comentario.
Así que agregue los comentarios mientras escribe el código.
Y los comentarios también pueden ayudar cuando intenta encontrar y corregir sus errores,
durante la fase de depuración. Si hay errores lógicos, puede
mirar los comentarios y puede aislar, bueno, este es
el error que sucedió.
Este comentario se alinea con esa funcionalidad.
Apuesto a que el error está en este grupo de código. Por lo que le ayuda a aislar errores en la depuración.
Un comentario puede ayudarlo a leer el programa, pero también puede señalar el origen de
un error lógico, por lo que los comentarios son importantes.
Ahora, el otro argumento al proporcionar comentarios es
que nuevamente existe este gran debate con los programadores, ¿cuántos comentarios brindan?
Y hay un buen libro llamado Clean Code, que habla sobre
cómo escribir código de calidad. Lo crea o no,
puede haber un código bueno o un código incorrecto, y eso
se conoce como la calidad del código.
Quieres escribir código de alta calidad.
Hablaremos de esto a lo largo del curso, pero muchos estudiantes que aprenden nuevos idiomas piensan que, siempre que
el resultado coincida con lo que necesito, no
importa cómo escriba el código. Eso no es cierto.
Porque de nuevo, recuerda esa fase de mantenimiento.
Recuerde que el producto o
el programa que publique estará en el campo tal vez durante varios años.
Entonces, si desea encontrar errores existentes o agregar nuevas funciones, es importante que
el código sea de muy alta calidad, más fácil de mantener, muy
poco acoplado y altamente cohesivo.
Y hablaremos de estos conceptos a medida que avanzamos.
Vamos a escribir código de alta calidad durante toda la clase.
Una de las formas de escribir código de alta calidad es proporcionar comentarios,
pero también proporcionar comentarios auto-documentados.
Lo que esto significa es realmente usar nombres significativos. De esto es de lo que habla el libro de Código Limpio.
Cuando cree una variable, use un nombre significativo.
Entonces, cuando mira la variable, sabe exactamente para qué se está utilizando, entonces
no necesita proporcionar un comentario.
Si tiene una función que suma 2 números, nombre la función suma 2 números.
Entonces, ¿necesita un comentario para decir qué está haciendo esa función? No.
Porque el nombre te dice lo que está haciendo.
Así que los nombres significativos son una buena forma de proporcionar comentarios autodocumentados.
Volvamos a nuestro ejemplo de nuestro desafío
y quiero mostrarte exactamente cómo
puedes agregar comentarios y dónde los agregas.
Y notará que el compilador ignorará estos comentarios.
Entonces, en nuestro primer ejemplo aquí, que es un programa básico,
normalmente agregaré comentarios de varias líneas en la parte superior del archivo antes de cualquier línea de código.
Y recuerde que podemos agregar esos comentarios de varias líneas simplemente proporcionando una barra, una estrella,
un asterisco para comenzar el comentario.
Y luego cualquier cosa entre el comentario
será el comentario,
cualquier cosa entre la estrella y el asterisco.
Y notarás cuando hago esa barra diagonal que todo es gris porque eso
me dice que no tengo mi comentario final en este momento.
Por lo tanto, debe agregar esa barra inclinada
de estrella para finalizar el comentario. Y verás que los colores ahora cambian.
Es por eso que me gusta usar un IDE porque te dice mucho con este formato de
colores coordinados.
Entonces, cualquier cosa entre la barra diagonal es el comienzo de un
comentario de varias líneas, cualquier cosa antes de la estrella hacia adelante es
la descripción o el final del comentario de varias líneas.
Y normalmente pongo en la parte superior del archivo
algo como autor y pongo mi nombre y luego pondré tal vez un propósito.
Esto suele ser una buena práctica y pondré algo como
este programa, imprime mi nombre en la pantalla.
Y luego, generalmente, proporcionaré una fecha de cuándo se creó, sea cual sea la fecha.
Y ese es un ejemplo de la parte superior de comentarios de varias líneas. Y luego proporcionaré comentarios a lo
largo del código. Por lo general, comentarios de
una línea o comentarios de varias líneas, solo depende de cuántos comentarios haya.
Entonces, tal vez no estemos familiarizados con este código. Y podría decir que sabe que 2
barras diagonales son un comentario de una sola línea. Puedo decir que este código
muestra mi nombre.
Y de nuevo, cuando proporciono estas barras diagonales o estos comentarios
de varias líneas, el compilador los ignora. Básicamente, puedes poner lo que quieras dentro y no importa.
No hay sintaxis que tengas que seguir, no hay nada.
Ignorar todo lo que está coloreado de gris aquí, se
considera un comentario.
Por tanto, los comentarios son algo fundamental en todo programa.
Quería describirlos desde el principio porque los utilizaré, y
deberías agregarlos mientras escribes tu código.
Además, con comentarios dentro del IDE,
hay ocasiones en las que está compilando su código y todo falla.
Y, por lo tanto, hay ocasiones en las que es posible que desee comentar
todo o comentar bloques de código para tratar de depurar su problema, intente aislar su error.
Puede resaltar varias líneas de código y luego ir
a la edición en el menú y puede decir
comentar o descomentar.
Si dices comentar, comentará todo ese código
que resaltaste.
Y luego puede volver a compilar y tal vez ya no tenga un error de compilación.
Es una forma de aislar errores en tiempo de ejecución o en tiempo de compilación.
Entonces, el IDE tiene algunas
herramientas agradables que le permiten comentar varias líneas automáticamente resaltando
y alternando.