code-comment

Community

Bilingual code comments for clear docs

Authorzhizhunbao
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill standardizes bilingual code documentation, ensuring Chinese and English readers can understand code bases without language barriers and reducing misinterpretation.

Core Features & Use Cases

  • File-level docstrings in English only for global context.
  • Function docstrings formatted as two-line bilingual entries (Chinese first, English second).
  • Inline comments that appear above code blocks, with Chinese followed by English explanations.
  • Import and module notes written in bilingual form to aid setup and usage.
  • Enforced code spacing and formatting rules to maintain consistency across files.

Quick Start

Apply the bilingual commenting standard to a sample code file and generate fully documented code.

Dependency Matrix

Required Modules

None required

Components

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: code-comment
Download link: https://github.com/zhizhunbao/ottawa-genai-research-assistant/archive/main.zip#code-comment

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 471,000+ vetted skills library on demand.