Comentarios de óxido
La capacidad de agregar comentarios a su código puede ayudar a mejorar la legibilidad para usted y otros desarrolladores que puedan leer y usar su código.
¿Cómo funcionan los comentarios??
Los comentarios no son nada especial. Son solo un conjunto de caracteres de texto que describen cómo o qué está haciendo un código.
El comentario utiliza caracteres especiales que hacen que el compilador los ignore. Discutamos cómo podemos implementar y usar comentarios en nuestros programas.
Comentarios de óxido
Hay tres tipos de comentarios en Rust:
- Comentarios simples o lineales
- Bloquear comentarios
- Comentarios de Doc
Déjanos discutir.
Comentarios de línea simple
Los comentarios simples o de línea son el tipo de comentarios que abarcan una sola línea. Se utilizan principalmente para insertar un mensaje corto y descriptivo en un bloque de código.
En Rust, podemos insertar comentarios de una sola línea usando caracteres de corte doble hacia adelante. Un ejemplo es como se muestra:
fn main ()// comentario de una sola línea
println!("Hola Mundo!");
Como se mencionó, un comentario de una sola línea abarca una sola línea. Como se muestra en el ejemplo, el compilador del compilador ignora la línea después de los dos caracteres de corte hacia adelante.
Bloquear comentarios
El segundo tipo de comentario se conoce como comentarios en bloque. Estos son muy similares a los simples
Sttart abriendo el bloque de comentarios con un personaje de barra de avance y un asterisco, como (/*).
Después de eso, podemos agregar el texto de comentarios y cerrar el bloque de comentarios con un asterisco y una reacción violenta como (*/).
Un ejemplo de un comentario de bloque en Rust es como se muestra:
fn main ()/*
Comentario de un bloque
tramos
líneas de mutliple
*/
println!("Hola Mundo!");
El código anterior muestra la creación de un comentario de bloque que abarca múltiples líneas.
Comentarios de Doc
Rust también nos proporciona comentarios de doctor. Hay dos tipos principales de comentarios de DOC en Rust:
- Comentarios de Doc Inter
- Comentarios de Doc Outer.
Comentarios de Doc Inter
Los comentarios de Doc Inner se denotan por una barra de doble delantera y una explosión como //!. Se escriben dentro de un bloque de código se utilizan principalmente para generar documentación para un código dentro de un bloque especificado.
Un ejemplo es como se muestra:
fn main ()//! documentación
println!("Hola Mundo!");
El código anterior denota un comentario interno docente.
Comentario de doctor exterior
Como su nombre lo indica, un comentario de documento externo se refiere a un comentario que rodea un bloque exterior de código y actuando como la documentación para ese bloque.
Los comentarios del documento exterior se denotan por triple barras delantera. Se muestra un ejemplo:
/// función principal//
fn main ()
println!("Hola Mundo!");
Conclusión
Este artículo lo ayuda a comprender varios tipos de comentarios en Rust y cómo crear mensajes cortos y descriptivos para sus bloques de código.
Esperamos que hayas disfrutado el artículo, gracias!