skills.rest
datamktkorea
datamktkoreaOFFICIAL
Explore all skills by this author →
WebsiteGitHub

format-code-comments

Add TSDoc and Google-style docstrings to TypeScript and Python code.

Updated Jan 24, 2026
Search Tags:#code review#code comments#automated documentation#TSDoc#Google-style docstrings
One-click install
npx skills add https://github.com/datamktkorea/agent-skills --skill format-code-comments
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: format-code-comments
Source: https://github.com/datamktkorea/agent-skills/tree/main/plugins/dmk-oneteam/skills/format-code-comments
Command: npx skills add https://github.com/datamktkorea/agent-skills --skill format-code-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typescript, python, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the addition, improvement, and standardization of comments and documentation in TypeScript and Python code, streamlining the code review and maintenance process.

Core Features & Use Cases

  • Automated Comment Addition: Adds TSDoc and Google-style docstrings to Python and TypeScript code based on analysis of changes.
  • Documentation Improvement: Enhances existing comments for accuracy and adherence to Korean language standards.
  • Use Case: When preparing a pull request, use this Skill to ensure all code is well-documented and ready for review.

Quick Start

Run the 'format-code-comments' skill to automatically add comments to your TypeScript file 'user.ts'.

Frequently Asked Questions about format-code-comments

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

FAQPage Schema
How do I automatically generate TSDoc and Google-style docstrings for my code?▼

Automated code comment formatting uses TypeScript and Python syntax analysis to generate TSDoc and Google-style docstrings. It identifies changes in your current branch and applies standardized documentation directly to the modified code.

Can I automatically add documentation comments to TypeScript and Python files before a pull request?▼

Yes, you can automate adding documentation comments to TypeScript and Python files before a pull request. This ensures all code is well-documented and ready for review by generating TSDoc and Google-style docstrings for branch changes.

What is the best way to standardize existing code comments for Python and TypeScript?▼

Standardizing existing code comments is best achieved by automating comment improvement and addition. This process enhances existing comments for accuracy and adherence to language standards while applying TSDoc and Google-style docstrings.

Does automated code documentation require understanding TypeScript and Python syntax structure?▼

Yes, automated code documentation requires knowledge of TypeScript and Python syntax and structure to accurately analyze changes. This syntax understanding is essential for correctly generating and applying TSDoc and Google-style docstrings.

How do code comment generators handle modifications in the current git branch?▼

Code comment generators handle modifications by identifying changes in the current branch. They analyze these specific updates to generate and apply accurate TSDoc and Google-style docstrings only to the modified code sections.

Related Skills

Explore More Software Engineering Skills→
dxpfigdxpfig

Analyzing AgentScope Library

Extract AgentScope module signatures, class and function definitions, and docstrings.

Community
Intermediate
skalanuxskalanux
1

python-code-style

Configures ruff, strict mypy/pyright, and Google-style docstrings for Python projects.

Community
Intermediate
archibatearchibate
6

python-code-style

Enforce Python style, type checks, and Google-style docstrings using ruff and mypy.

Community
Intermediate
raykrayk
3

operation-tracker

Track reads, edits, and file turns to trigger delegation thresholds.

Community
Advanced