global-commenting
Write Clear Evergreen Code Comments
Teams often add comments that become stale or repeat obvious code. This skill guides AI assistants to write minimal comments that explain non-obvious decisions.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
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.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "global-commenting". A service method contains several comments that restate each assignment and condition.
Expected outcome:
The review removes redundant comments and keeps one short note explaining the business rule behind the condition.
Using "global-commenting". A TypeScript function has complex date logic with no context.
Expected outcome:
The result adds a concise TSDoc summary and one inline comment explaining the calendar rule.
Using "global-commenting". A pull request adds comments about a temporary migration workaround.
Expected outcome:
The review suggests removing time-bound wording and documenting the stable reason for the compatibility check.
Security Audit
SafeThe 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.
Risk Factors
📁 Filesystem access (1)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/devanb-global-commenting/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/devanb-global-commenting?utm_source=security_passport_badge)HTML badge
<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>Embed card
<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>Academic citations (APA · BibTeX · CFF)
APA citation
DevanB. (2026). global-commenting security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/devanb-global-commenting/audits/10BibTeX citation
@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"
Compare variants
2 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
devanb-global-commenting
2026-08-21
eis-its-global-commenting
2026-08-21
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Improve Existing Code Comments
Review comments in a codebase and keep only those that explain lasting context.
Standardize Docblocks
Create PHPDoc, JSDoc, or TSDoc comments that match a minimal commenting style.
Reduce Comment Noise
Identify comments that repeat code behavior and suggest clearer naming or structure.
Try These Prompts
Review this code and add only comments that explain non-obvious decisions. Avoid comments that repeat what the code already says.
Add PHPDoc, JSDoc, or TSDoc comments where they help future maintainers. Keep each comment concise and focused on intent.
Review the existing comments in this change. Mark stale, redundant, or temporary comments, and suggest durable replacements only where needed.
Find places where clearer names or structure would remove the need for comments. Add comments only for business rules or algorithms that remain non-obvious.
Best Practices
- Explain why code exists when the reason is not clear from names and structure.
- Prefer clearer code before adding a comment.
- Keep comments durable by avoiding release dates, temporary notes, and recent-change history.
Avoid
- Do not comment every line or repeat obvious control flow.
- Do not preserve stale comments after logic changes.
- Do not use comments to hide unclear naming or overly complex structure.