English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Comentários do Rust

As formas de comentário no Rust são como outras linguagens (C, Java), suportando duas formas de comentário:

// Esta é a primeira forma de comentário
/* Esta é a segunda forma de comentário */ 
/* 
 * Comentários multilinha
 * Comentários multilinha
 * Comentários multilinha
 */

comentários de documentação

No Rust, usar // podem tornar o conteúdo após a primeira quebra de linha em comentários.

Neste contexto, três barras invertidas /// É ainda um início de comentário válido. Portanto, o Rust pode usar /// Como início de comentários de documentação:

///Adiciona um ao número fornecido. 
/// 
///# Exemplos 
/// 
///``` 
///let x = add(1, 2); 
/// 
///``` 
fn add(a: i32, b: i32) -> i32 { 
    return a + b; 
} 
    
fn main() { 
    println!("{}",add(2,3)); 
}

A função add do programa terá um comentário elegante e pode ser exibido no IDE:

Dica:O Cargo possui a função cargo doc, os desenvolvedores podem usar este comando para transformar os comentários de documentação de um projeto em documentos de documentação em formato HTML.