global-commenting
Escribir comentarios de código claros y duraderos
Los equipos suelen añadir comentarios que quedan obsoletos o repiten código evidente. Esta skill guía a los asistentes de IA para escribir comentarios mínimos que expliquen decisiones no evidentes.
Instalar con mi Agente
Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.
Review the Skillstore skill "global-commenting" from https://skillstore.io/skills/devanb-global-commenting.md and its manifest at https://skillstore.io/api/skills/devanb-global-commenting/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Tu Agente debe seguir mostrando su plan y solicitar cualquier confirmación exigida por la política de seguridad.
Recursos legibles por agentes
Usa estos enlaces cuando un agente de IA, crawler o script necesite contexto limpio en vez de leer la página completa.
Pruébalo
Usando "global-commenting". Un método de servicio contiene varios comentarios que reformulan cada asignación y condición.
Resultado esperado:
La revisión elimina comentarios redundantes y conserva una nota breve que explica la regla de negocio detrás de la condición.
Usando "global-commenting". Una función de TypeScript tiene lógica de fechas compleja sin contexto.
Resultado esperado:
El resultado añade un resumen TSDoc conciso y un comentario inline que explica la regla de calendario.
Usando "global-commenting". Un pull request añade comentarios sobre una solución temporal para una migración.
Resultado esperado:
La revisión sugiere eliminar formulaciones limitadas en el tiempo y documentar la razón estable de la comprobación de compatibilidad.
Auditoría de seguridad
SeguroThe static path traversal alert is a fixed Markdown link to a project standards document, not executable code or user-controlled file access. No prompt injection, data exfiltration, or malicious intent was found in SKILL.md.
Factores de riesgo
📁 Acceso al sistema de archivos (1)
Compartir y citar este informe
Comparte el informe de evaluación versionado, la insignia neutral, la tarjeta insertable y las citas. Skillstore presenta evidencias sin decidir si este Skill es seguro.
Copiar enlace del informe
https://skillstore.io/skills/devanb-global-commenting/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportInsignia Markdown
[](https://skillstore.io/skills/devanb-global-commenting?utm_source=security_passport_badge)Insignia HTML
<a href="https://skillstore.io/skills/devanb-global-commenting?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/devanb-global-commenting/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Tarjeta para insertar
<iframe src="https://skillstore.io/embed/skills/devanb-global-commenting.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Citas académicas (APA · BibTeX · CFF)
Cita APA
DevanB. (2026). global-commenting security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/devanb-global-commenting/audits/10Cita BibTeX
@techreport{devanb-devanb-global-commenting-2026,
author = {DevanB},
title = {global-commenting security audit report (audit version 10)},
institution = {Skillstore},
year = {2026},
number = {10},
url = {https://skillstore.io/skills/devanb-global-commenting/audits/10},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "global-commenting security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
- name: "DevanB"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/devanb-global-commenting/audits/10"
identifiers:
- type: other
value: "skillstore:devanb-global-commenting:audit:10"
description: "Skillstore immutable audit report identifier"
Comparar variantes
2 variantes instalablesCada autor sigue siendo un skill instalable independiente. La variante recomendada se ordena según la evidencia de Skillstore.
Por qué esta variante es la primera
devanb-global-commenting
2026-09-09
eis-its-global-commenting
2026-09-09
Puntuación de Skillstore
Por qué esta puntuación Confianza de la evidencia: AltoLo que puedes crear
Mejorar comentarios de código existentes
Revisar los comentarios en una base de código y conservar solo los que explican contexto duradero.
Estandarizar docblocks
Crear comentarios PHPDoc, JSDoc o TSDoc que coincidan con un estilo mínimo de comentarios.
Reducir ruido en los comentarios
Identificar comentarios que repiten el comportamiento del código y sugerir nombres o estructuras más claros.
Prueba estos prompts
Revisa este código y añade solo comentarios que expliquen decisiones no evidentes. Evita comentarios que repitan lo que el código ya dice.
Añade comentarios PHPDoc, JSDoc o TSDoc donde ayuden a futuros mantenedores. Mantén cada comentario conciso y centrado en la intención.
Revisa los comentarios existentes en este cambio. Marca comentarios obsoletos, redundantes o temporales, y sugiere reemplazos duraderos solo donde sea necesario.
Encuentra lugares donde nombres o estructuras más claros eliminarían la necesidad de comentarios. Añade comentarios solo para reglas de negocio o algoritmos que sigan siendo no evidentes.
Mejores prácticas
- Explica por qué existe el código cuando la razón no está clara a partir de los nombres y la estructura.
- Prefiere código más claro antes de añadir un comentario.
- Mantén los comentarios duraderos evitando fechas de lanzamiento, notas temporales e historial de cambios recientes.
Evitar
- No comentes cada línea ni repitas el flujo de control evidente.
- No conserves comentarios obsoletos después de cambios en la lógica.
- No uses comentarios para ocultar nombres poco claros o estructuras demasiado complejas.