What specific code patterns does this skill target?

The skill specifically targets pure virtual methods in C++ header files (.h, .hpp) that follow the 'virtual ... = 0;' syntax.

Is the comment template customizable?

Yes, while it defaults to a standard Purpose/Notes/Args/Return format, you can override the comment text using parameters.

Can I preview changes before they are applied?

Yes, the skill supports a dry-run mode that reports proposed changes without modifying the actual files.

Will this skill overwrite my existing comments?

No, it is designed to merge with existing comments or skip files that are already annotated, unless the --force flag is used.

Does it support recursive directory scanning?

Yes, it uses glob patterns to scan entire directories and subdirectories for C++ header files.

C++ Interface Documentation Automator

Name: C++ Interface Documentation Automator
Author: hzqst

byhzqst

•

214

•

Developer Tools

Automates the addition of standardized purpose, argument, and return value comments to C++ pure virtual methods.

This skill streamlines the documentation process for C++ interface classes by automatically inserting structured comment blocks above pure virtual method declarations. It ensures architectural consistency across header files by enforcing a standard template (Purpose, Notes, Args, Return) while intelligently merging existing comments and respecting code indentation. Specifically optimized for C++ projects like MetaHookSv, it allows developers to maintain clear API contracts and improve code readability across large codebases with minimal manual effort.

Key Features

01Support for multi-line declarations and complex C++ syntax

02Automated template generation for pure virtual method declarations

03Context-aware merging with existing code comments and notes

04Customizable comment fields including Purpose, Args, and Return values

05Bulk processing capabilities via Python scripts with dry-run support

06214 GitHub stars

Use Cases

01Enforcing consistent code style guidelines for C++ interface declarations

02Batch annotating legacy header files that lack descriptive comments

03Standardizing API documentation across a large C++ engine modding framework

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hzqst/metahooksv cpp-interface-purpose-comments

For use in Claude.ai and ChatGPT

Download Skill