comment-style

Enforce centralized commenting conventions with labels, section dividers, and CLAUDE instruction tags.

68|3|Updated Apr 24, 2025
One-click install
npx skills add https://github.com/TophC7/dot.nix --skill comment-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: comment-style
Source: https://github.com/TophC7/dot.nix/tree/main/modules/home/common/claude/skills/comment-style
Command: npx skills add https://github.com/TophC7/dot.nix --skill comment-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill standardizes and enforces consistent commenting conventions across codebases, improving readability and maintainability.

Core Features & Use Cases

  • Labeling system for comments with visual highlighting
  • Section dividers and mirrored markers to organize code
  • Documentation guidance including how to annotate code and how to use CLAUDE instructions

Quick Start

Apply this style guide to all code you write or review to ensure consistent, clearly labeled comments.

Frequently Asked Questions about comment-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent code commenting conventions across multiple programming languages?

You can enforce consistent code commenting conventions across multiple languages by applying a centralized style guide that imposes rules for label usage, section dividers, and AI instruction tagging to ensure readable, auditable comments.

What is the best way to standardize code documentation and reduce ambiguity in source code?

Standardize code documentation and reduce ambiguity by enforcing a centralized commenting convention that guides code generation, reviews, refactoring, and documentation tasks with consistent, clearly labeled comments.

How do I structure section dividers and labeled comments for code reviews?

Structure section dividers and labeled comments for code reviews by applying a standardized convention that uses mirrored markers and a labeling system with visual highlighting to organize source code.

Can I use a centralized commenting convention to guide code generation and refactoring?

Yes, you can use a centralized commenting convention to guide code generation and refactoring by imposing strict rules for label usage and AI instruction tagging, ensuring code remains consistent and auditable.

Does this code documentation style work without specific framework dependencies?

Yes, this code documentation style works without specific framework dependencies because it applies universally across languages and projects, requiring no external components to enforce its commenting rules.

How do I tag AI instructions in source code comments for auditable reviews?

Tag AI instructions in source code comments for auditable reviews by using the CLAUDE instruction tagging mechanism, which imposes specific rules to ensure AI-generated code remains clearly labeled and readable.