coding-comments

Write clear code comments using Taylor-style block formatting.

1|Updated Feb 11, 2024

Search Tags:#documentation #readability #style #coding #comments #top-level

Ready to run

npx skills add https://github.com/loklaan/dotfiles --skill coding-comments

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: coding-comments
Source: https://github.com/loklaan/dotfiles/tree/main/home/dot_claude/skills/coding-comments
Command: npx skills add https://github.com/loklaan/dotfiles --skill coding-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guidelines for writing clear, effective code comments that improve readability and maintainability.

Core Features & Use Cases

Taylor-style comments: Adopt a consistent commenting style for top-level descriptions.
Practical examples: Real-world formatting patterns for long descriptions.
Usage tips: Guidance for integrating comments into codebases.

Quick Start

Update a sample file to replace a messy inline comment with a Taylor-style block comment.