sdcorejs-comment-code
CommunityAlways ask comment level before writing code
Software Engineering#typescript#jsdoc#code commenting#documentation conventions#ai coding workflow#bilingual vi en#jest or test invariants
Authorsdcorejs
Version1.0.0
Installs0
System Documentation
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/fullbefore any comments are added, aligned to the session language (VI/EN). - Progressive commenting rules: applies increasingly richer JSDoc and inline
// whyexplanations depending on the selected level, including optional companion documentation atfull. - Workflow integration: runs after
50-review-code/orchestration/repair-loop(if applicable) and beforeorchestration/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.
Dependency Matrix
Required Modules
None requiredComponents
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: sdcorejs-comment-code Download link: https://github.com/sdcorejs/sdcorejs-agent/archive/main.zip#sdcorejs-comment-code Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.