Verified:GitHub

sdcorejs-comment-code

Enforce user-selected comment levels with JSDoc and inline why rules.

2|Updated Apr 18, 2026

Search Tags:#typescript #jsdoc #code commenting #documentation conventions #ai coding workflow #bilingual vi en #jest or test invariants

Ready to run

npx skills add https://github.com/sdcorejs/sdcorejs-agent --skill sdcorejs-comment-code

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sdcorejs-comment-code
Source: https://github.com/sdcorejs/sdcorejs-agent/tree/main/plugin/skills/sdcorejs-comment-code
Command: npx skills add https://github.com/sdcorejs/sdcorejs-agent --skill sdcorejs-comment-code

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents blindly auto-commenting or omitting comments by forcing an explicit user decision at the comment phase, so code stays readable without bloating files.

Core Features & Use Cases

Mandatory ASK gate: always prompts the user to choose skip / simple / medium / full before any comments are added, aligned to the session language (VI/EN).
Progressive commenting rules: applies increasingly richer JSDoc and inline // why explanations depending on the selected level, including optional companion documentation at full.
Workflow integration: runs after 50-review-code / orchestration/repair-loop (if applicable) and before orchestration/verify-before-done, and triggers when the user asks for comments or comment level.
Use cases: after code generation for Angular Portal, NestJS, or Next.js tasks, when the user wants consistent team conventions for documentation density and “why” explanations.

Quick Start

Tell the agent “comment level full” after it generates code to apply the richest JSDoc and design rationale documentation for non-obvious module decisions.

Frequently Asked Questions about sdcorejs-comment-code

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

FAQPage Schema

How do I stop an AI coding assistant from adding too many comments to TypeScript code?▼

To stop excessive comments in TypeScript code, use a comment insertion gate that forces the AI to ask for a comment level before writing. Choosing 'skip' or 'simple' prevents unnecessary code bloat while maintaining readable files.

What is the best way to enforce JSDoc conventions during an AI code-writing workflow?▼

The best way to enforce JSDoc conventions in an AI workflow is to apply deterministic JSDoc rules based on a user-selected comment level. This ensures consistent inline 'why' explanations and documentation density across Angular, NestJS, or Next.js projects.

Can I control how much documentation the AI generates for my NestJS modules?▼

Yes, you can control AI documentation density for NestJS modules by triggering a mandatory comment level prompt. You can select 'medium' for standard JSDoc or 'full' to generate companion WHY-X.md files and test invariants.

What comment levels should I use for different code documentation needs?▼

Comment levels for different documentation needs include 'skip' for no comments, 'simple' for basic inline notes, 'medium' for standard JSDoc, and 'full' for rich JSDoc, design rationale documentation, and test invariants.

When should I use full code commenting instead of simple inline comments?▼

You should use full code commenting instead of simple inline comments when you need to document non-obvious module decisions, generate design rationale files, and establish test invariants for complex Angular Portal, NestJS, or Next.js tasks.

Does the comment insertion gate support bilingual English and Vietnamese prompts?▼

Yes, the comment insertion gate supports bilingual prompts aligned to the session language. It can present the 'skip', 'simple', 'medium', and 'full' options in either English or Vietnamese before applying JSDoc conventions.