semantic-commenting
CommunityAdd trustworthy semantic anchors for retrieval.
Software Engineering#invariants#protocols#code retrieval#repoindex#semantic comments#evidence anchors#code-to-doc links
Authorjoshka0
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps you write semantic code comments that future agents can reliably retrieve and use to understand, navigate, and validate important behavior in a codebase.
Core Features & Use Cases
- Semantic comment lanes: create broad discoverability with structured Index blocks and create durable, evidence-only contracts with [[...]] semantic anchors.
- Typed, evidence-focused contracts: capture invariants, risks, protocols, domains, decisions, doc and test proof points using consistent wikilink anchor syntax.
- Better navigation and review signals: ensure anchors are placed near the true owner, use stable lowercase slugs, and keep Index blocks for navigation rather than authority.
Quick Start
Use semantic-commenting to add Index metadata and high-value [[type:slug]] anchors near the code boundary that enforces a specific protocol or safety invariant, then validate anchor parsing with the project-native tests.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: semantic-commenting Download link: https://github.com/joshka0/foxctl/archive/main.zip#semantic-commenting Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.