Skills
.Work. You
Rest

vue-comment

Official

Harmonize Vue code with consistent comments.

Software Engineering#vue#jsdoc#naming-conventions#code-review#code-comments#component-development
Authorwot-ui
Version1.0.0
Installs0

System Documentation

What problem does it solve?

统一 Vue 项目中的代码注释格式与命名约定，覆盖组件 Props 注释、函数命名、类型说明、变量命名以及文件目录的命名规则，提升代码可读性与可维护性。

Core Features & Use Cases

  • 命名规范: 文件/目录使用 kebab-case，变量使用 camelCase，常量使用 UPPER_SNAKE_CASE，函数使用 camelCase，类/接口使用 PascalCase。
  • 注释规范: 组件 Props、函数、变量、类型定义均需 JSDoc 风格注释，提供清晰的描述、类型与默认值信息。
  • 职责边界与使用场景: 支持代码维护、功能开发、代码评审、组件补充注释等常见工作流。

Quick Start

Follow the Vue comment and naming standard when creating a new component by adding structured JSDoc comments for props and functions and converting identifiers to kebab-case.

Dependency Matrix

Required Modules

None required

Components

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: vue-comment
Download link: https://github.com/wot-ui/wot-ui/archive/main.zip#vue-comment

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.