What are 'lying comments' and does this skill detect them?

Lying comments are annotations that no longer match the code's behavior; this skill focuses on identifying these discrepancies during code review to maintain documentation accuracy.

What is the 'Why, Not What' rule in code commenting?

It is the principle that comments should explain the reasoning, choices, or constraints behind a piece of code, rather than simply narrating what the code's syntax is already doing.

Can this skill help with API deprecation?

Yes, it provides a standardized deprecation pattern that includes the version since deprecation, the replacement path, and the scheduled removal date.

How does this skill improve TODO management?

It enforces a standard where every TODO must include an owner and a specific deadline or trigger for removal, preventing 'dead' TODOs from cluttering the codebase.

Professional Code Commenting Patterns

Name: Professional Code Commenting Patterns
Author: HermeticOrmus

byHermeticOrmus

0•

学习与文档

Implements high-standard documentation patterns that focus on explaining the logic and intent behind code rather than just describing its syntax.

This skill enhances Claude's ability to generate and review code comments by prioritizing the 'Why' over the 'What'. It provides a structured framework for documenting non-obvious algorithms, external bug workarounds, business logic constraints, and magic numbers. By enforcing strict standards for TODOs and deprecation notices, it ensures that your codebase remains maintainable, context-rich, and free from redundant or misleading documentation.

主要功能

01Enforces the 'Why, Not What' principle for meaningful documentation

02Identifies and eliminates anti-patterns like 'lying' or 'echoing' comments

03Generates clear deprecation paths with explicit migration instructions

04Standardizes TODO comments with ownership and expiry context

05Provides templates for documenting complex algorithms and business rules

060 GitHub stars

使用场景

01Refactoring legacy codebases to improve long-term maintainability and developer onboarding

02Automating code reviews to ensure documentation meets professional technical writing standards

03Documenting complex business logic that requires alignment with external specifications or Jira tickets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/librecopy-claude-code code-comment-patterns

For use in Claude.ai and ChatGPT

主要功能

01Enforces the 'Why, Not What' principle for meaningful documentation

02Identifies and eliminates anti-patterns like 'lying' or 'echoing' comments

03Generates clear deprecation paths with explicit migration instructions

04Standardizes TODO comments with ownership and expiry context

05Provides templates for documenting complex algorithms and business rules

060 GitHub stars

使用场景

01Refactoring legacy codebases to improve long-term maintainability and developer onboarding

02Automating code reviews to ensure documentation meets professional technical writing standards

03Documenting complex business logic that requires alignment with external specifications or Jira tickets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/librecopy-claude-code code-comment-patterns

For use in Claude.ai and ChatGPT