Prompt completo
"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
Rust
Documentação em Rust
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Rust
ChatGPT
Melhores práticas de debugging em rust para Rust
Prompt gerado automaticamente para Debugging em Rust em Rust
2 usos
ChatGPT
Guia para padrões de design em rust em Rust
Prompt gerado automaticamente para Padrões de design em Rust em Rust
4 usos
ChatGPT
Guia para troubleshooting em rust em Rust
Prompt gerado automaticamente para Troubleshooting em Rust em Rust
5 usos