skills.rest
wot-ui
wot-uiOFFICIAL
Explore all skills by this author →
GitHub

vue-comment

Enforce JSDoc comments and kebab-case naming across Vue codebases.

284|31|Updated Jan 15, 2026
Search Tags:#vue#jsdoc#naming-conventions#code-review#code-comments#component-development
One-click install
npx skills add https://github.com/wot-ui/wot-ui --skill vue-comment
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: vue-comment
Source: https://github.com/wot-ui/wot-ui/tree/main/.agents/skills/vue-comment
Command: npx skills add https://github.com/wot-ui/wot-ui --skill vue-comment

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about vue-comment

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

FAQPage Schema
How do I standardize Vue component comments and naming conventions across an existing project?▼

To standardize Vue comments and naming conventions, apply JSDoc annotations to component Props, functions, and types, while converting file and directory identifiers to kebab-case for uniform documentation and code style.

What naming conventions should I use for Vue variables, constants, and classes?▼

Vue naming conventions require camelCase for variables and functions, UPPER_SNAKE_CASE for constants, PascalCase for classes and interfaces, and kebab-case for file and directory names to ensure structural consistency.

How do I add JSDoc comments to Vue component Props?▼

Add JSDoc comments to Vue component Props by providing clear descriptions, type definitions, and default value information directly above the Props declarations to improve code readability and maintainability.

Does this Vue comment and naming standard work for ongoing projects and new components?▼

Yes, this Vue comment and naming standard is applicable to both ongoing projects and new components, supporting common workflows like code maintenance, feature development, and code review.

What are the limitations of enforcing kebab-case directory naming in Vue?▼

The standard enforces kebab-case directory naming to maintain uniform file structures, but developers should verify that existing build tools and path aliases resolve correctly when migrating older Vue codebases.

Why does my Vue code review fail on missing type definitions and function comments?▼

Vue code reviews fail when functions, variables, and type definitions lack structured JSDoc comments that provide clear descriptions, type information, and default values required by the standard.

Related Skills

Explore More Software Engineering Skills→
pvillegapvillega
23

lint-guard

Detect languages, configure per-language linters, and run complexity checks.

Community
Advanced
Design-System-ETDesign-System-ET

vue-expert-js

Create Vue 3 components and composables with JSDoc type annotations.

Official
Intermediate
Yoriichi-DangYoriichi-Dang

web-component-design

Guide design of reusable UI components across React, Vue, and Svelte.

Community
Basic
AbeJitsuAbeJitsu

format-standardize

Apply user-defined formatting standards across code, documentation, and content outputs using ESLint and Prettier.

Community
Basic