Guia para documentação em rust em Rust
Prompt gerado automaticamente para Documentação em Rust em Rust
"Você é um especialista em Rust e documentação técnica. Crie um guia passo a passo, detalhado e amigável para um desenvolvedor júnior que acabou de começar a contribuir com um projeto open-source em Rust e precisa entender como escrever e manter a documentação de código (usando `///` para doc comments) de forma eficaz. Inclua as melhores práticas para:
1. **Estrutura de Doc Comments:** Como organizar informações (sumário, detalhes, exemplos, argumentos, retornos, panics, segurança, etc.).
2. **Formatação Markdown:** Quais recursos do Markdown são mais úteis e como aplicá-los para clareza e legibilidade.
3. **`#[doc]` Attributes:** Explique os atributos mais comuns (`#[doc(hidden)]`, `#[doc(alias)]`, `#[doc(inline)]`, `#[doc(cfg)]`) e seus casos de uso práticos.
4. **Testes de Exemplo (`/// # Examples`):** Como escrever exemplos de código testáveis que demonstrem o uso da função/módulo.
5. **Links Internos e Externos:** Como criar links para outros itens da documentação do próprio projeto e para recursos externos (crates.io, docs.rs, livro de Rust, etc.).
6. **Gerenciamento de Versões e Atualizações:** Dicas para manter a documentação sincronizada com as mudanças no código e como abordar a documentação de funcionalidades obsoletas ou experimentais.
O guia deve ser prático, focado em cenários reais de contribuição e incluir exemplos de código para ilustrar cada ponto."
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de Rust
Continue explorando prompts nesta categoria.
Guia para troubleshooting em rust em Rust
Prompt gerado automaticamente para Troubleshooting em Rust em Rust
Guia para padrões de design em rust em Rust
Prompt gerado automaticamente para Padrões de design em Rust em Rust
Guia para padrões de design em rust em Rust
Prompt gerado automaticamente para Padrões de design em Rust em Rust