skills.rest
slashwhy
slashwhyOFFICIAL
Explore all skills by this author →
WebsiteGitHub

code-documentation

Enforces TSDoc and inline comment best practices for documenting exported functions and Vue components.

5|1|Updated Jan 16, 2026
Search Tags:#documentation#code comments#developer productivity#tsdoc#vue components
One-click install
npx skills add https://github.com/slashwhy/super-todo --skill code-documentation-slashwhy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/slashwhy/super-todo/tree/main/.github/skills/code-documentation
Command: npx skills add https://github.com/slashwhy/super-todo --skill code-documentation-slashwhy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers write clear and concise documentation for their code, ensuring that the 'why' behind complex logic is understood, and that public APIs are well-defined.

Core Features & Use Cases

  • TSDoc for Exports: Standardizes documentation for functions, composables, and utils.
  • Vue Component Docs: Provides a template for documenting component props and emits.
  • Inline Comment Guidance: Emphasizes documenting the reasoning ('why') rather than the implementation ('what').
  • Annotation Keywords: Introduces standard keywords like TODO, FIXME, HACK, and NOTE.
  • Use Case: When writing a new utility function that will be exported from a library, use this skill to generate TSDoc comments explaining its purpose, parameters, and return values.

Quick Start

Use the code-documentation skill to add TSDoc comments to the exported function calculateTotal.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I write TSDoc comments for exported Vue components and functions?▼

To write TSDoc comments for Vue components and exported functions, document props, emits, parameters, and return values using standardized annotation blocks. This practice ensures public APIs are well-defined and clarifies component contracts for maintainability.

What is the best way to document complex logic in code comments?▼

The best way to document complex logic in code comments is to explain the reasoning or 'why' behind the implementation rather than the 'what'. This approach uses standardized inline comments to ensure the underlying logic is understood by future developers.

When should I use annotation keywords like TODO and FIXME in TypeScript?▼

You should use annotation keywords like TODO, FIXME, HACK, and NOTE in TypeScript when marking areas needing future attention, temporary workarounds, or important contextual notes. Standardizing these keywords facilitates understandable and maintainable codebases.

Does this code documentation approach work with Vue composables and utils?▼

Yes, this code documentation approach works directly with Vue composables and utils by standardizing TSDoc for exports. It provides specific templates to document component props, emits, and utility function returns effectively.

Related Skills

Explore More Software Engineering Skills→
leodieguesleodiegues

typescript-tsdoc

Standardize TSDoc blocks for TypeScript declarations and exports.

Community
Intermediate
mei28mei28
3

doc-gen

Generate OpenAPI specs and Markdown API references from codebases.

Community
Advanced
TeiNamTeiNam
12

laravel-verification

Automate Laravel project verification for CI/CD pipelines.

Community
Advanced
Sir-chawakornSir-chawakorn
33

code-explanation

Explain complex code snippets with multi-level breakdowns and flowcharts.

Community
Intermediate