inline-documentation

Name: inline-documentation
Author: troykelly

Escrita e Conteúdo

Autor: troykelly

Use when writing code - ensure complete JSDoc, docstrings, and inline comments assuming documentation will be generated from code

10estrelas

Atualizado há 9 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add troykelly/claude-skills

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/inline-documentation/svg)](https://www.skillteca.com.br/skills/inline-documentation)

#git #github

Skills relacionadas

Ver todas de Escrita e Conteúdo →

algorithmic-art

153.1k

Cria arte algorítmica original usando p5.js, aleatoriedade com semente e exploração interativa de parâmetros. Use para solicitações de arte generativa, campos de fluxo ou sistemas de partículas, garantindo a não violação de direitos autorais.

Escrita e Conteúdo por anthropics

doc-coauthoring

153.1k

Guia usuários por um fluxo de trabalho estruturado para coautoria de documentação, propostas, especificações técnicas e conteúdo similar. Ajuda a transferir contexto de forma eficiente, refinar o conteúdo por iteração e verificar sua eficácia para os leitores.

Escrita e Conteúdo por anthropics

copywriting-psychologist

41.2k

One sentence - what this skill does and when to invoke it

Escrita e Conteúdo #git #github por sickn33

documentation-generation-doc-generate

41.2k

Especialista em documentação que cria documentação abrangente e de fácil manutenção a partir do código, gerando documentação de API, diagramas de arquitetura, guias do usuário e referências técnicas usando análise impulsionada por IA e as melhores práticas da indústria.

Escrita e Conteúdo #ai #api por sickn33

Alerta por categoria

Receba novas skills de Escrita e Conteúdo toda segunda

1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Inline Documentation

Overview

Document code assuming docs will be generated from it.

Core principle: Future developers (including you) will read this code. Help them.

Announce at use: "I'm adding complete inline documentation for this code."

What to Document

Always Document

| Element | Documentation Required | |---------|----------------------| | Public functions/methods | Full JSDoc/docstring | | Public classes | Class-level documentation | | Public interfaces/types |

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn