inline-docs

仓库创建 2026年7月7日最近提交 22 天前SkillHot 收录 22 天前

▸ 精选理由

强调简洁、避免 token bloat，利于审查和维护

这个 Skill 做什么

为代码生成精简高效的行内注释与文档

写代码时自动生成精炼的行内注释和文档，让别人能快速读懂实现细节。常在编写、修改或审查代码时用到，尤其想把复杂逻辑压成一句话解释时。特点是像资深工程师写法，短句、只写必要信息，避免冗长说明和 token 冗余。

▸ 展开 SKILL.md 英文原文

Document code using efficient inline comments. Use whenever writing, editing, or reviewing code or if the user mentions documentation.

开发编程注释规范行内文档简洁通用

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/ethan-ngai/skills/main/skills/inline-docs/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/ethan-ngai/skills/main/skills/inline-docs/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Inline Documentation

Documentation serves to remedy ambiguity and provide otherwise missing context. A comment must earn its place and should not be added solely for ceremony. Keep docs lean to avoid token bloat.

## Style

- Avoid long, unnecessary prose. Write like a senior developer in terse fragments.
-  Only write about what is directly relevant and necessary to understand the code. 
- **Don’t** include historical references or specifics to the current session’s context. Assume that the docs will live long past the current situation.
- Avoid over-explaining obvious code. Do not include a reason for code if it is highly situational/references past conversations.
- Inline docs (`//` co

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有