Skills
.Work. You
Rest

Code Comments Skill

Community

Enhance code clarity with expert comments.

Software Engineering#code quality#developer tools#documentation#technical writing#code comments#programming best practices
Authoryangqiong
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the challenge of writing effective, maintainable code comments and documentation, ensuring that code is understandable and its purpose is clear to all developers.

Core Features & Use Cases

  • Comment Best Practices: Provides clear guidelines on when and how to write comments, distinguishing between necessary explanations and redundant information.
  • Documentation Formats: Demonstrates standard documentation formats for various programming languages (JSDoc, Python Docstrings, JavaDoc, Go).
  • Comment Types: Details on documenting functions, classes, inline explanations, and file headers.
  • Special Tags: Introduces useful tags like TODO, FIXME, HACK, NOTE, OPTIMIZE, and SECURITY for structured annotations.
  • Use Case: A developer can use this skill to understand how to properly document a complex algorithm, ensuring future maintainability and collaboration.

Quick Start

Use the Code Comments Skill to add documentation to the provided JavaScript function.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: Code Comments Skill
Download link: https://github.com/yangqiong/claude-skills/archive/main.zip#code-comments-skill

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.