← ClaudeAtlas

doc-writerlisted

Gera bloco Protheus.doc canônico TOTVS para função ADVPL/TLPP a partir de flags estruturadas — inverso de /plugadvpl:docs (v0.17.0+)
JoniPraia/plugadvpl · ★ 12 · Data & Documents · score 72
Install: claude install-skill JoniPraia/plugadvpl
# `/plugadvpl:doc-writer` **Inverso de `/plugadvpl:docs`** (v0.4.2 lê blocos Protheus.doc; v0.17.0 **gera**). Recebe metadata estruturada via flags CLI e devolve o bloco `/*/{Protheus.doc} ... /*/` no formato canônico TOTVS, pronto pra colar antes da declaração da função no fonte ADVPL/TLPP. **Padrão oficial seguido:** https://github.com/totvs/tds-vscode/blob/master/docs/protheus-doc.md Roundtrip-compatible: `plugadvpl docs --show <funcao>` recupera as tags geradas via `doc-writer` sem perda. ## Quando usar - LLM acaba de **escrever** ou **refatorar** uma função ADVPL/TLPP e precisa adicionar header documentado. - Função existente sem `/*/{Protheus.doc} ... /*/` (cobertura ruim em `/plugadvpl:cobertura-doc` ou aparece em `/plugadvpl:docs --orphans`). - Padronizar headers num módulo inteiro (combinar com `/plugadvpl:find --semDoc` + loop). - Migrar comentários soltos pra `@param/@return/@deprecated` canônicos. **Não use** se a função já tem header — primeiro rodar `/plugadvpl:docs --show <funcao>` pra verificar. ## Uso ``` /plugadvpl:doc-writer <funcao> [--type function|user_function|method|class|property] [--summary "descrição curta"] [--author "<nome>"] [--since YYYY-MM] [--version X.Y.Z] [--deprecated "motivo"] [--param "nome,tipo,desc"] (repetível; [nome] = opcional) [--return "tipo,desc"] [--example "snippet"] (repetível) ``` **Output:** bloco no stdout, pronto pra colar. ## Exemplos ### Mínimo (só nome) ```bash plugadvpl doc-writer