菜单
Use this skill when writing, reviewing, or refactoring code to ensure it is self-documenting. Apply these checklists to routines, data naming, data organization, and overall code layout to improve code clarity and maintainability without relying on comments.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Comprehensive PDF manipulation toolkit for extracting text and tables, creating new PDFs, merging/splitting documents, and handling forms. When Claude needs to fill in a PDF form or programmatically process, generate, or analyze PDF documents at scale.
Organize class members in standard order, separate classes with blank lines, and maintain one-class-per-file structure. Use when designing class interfaces, implementing classes, organizing project files, or establishing OOP coding standards.
Use specific checklists to ensure comprehensive and high-quality code commenting for general code, data declarations, and program structures. Apply when writing new code, reviewing existing code, or conducting code reviews to ensure completeness and quality of documentation.
Apply strategic approaches to code commenting including when to comment, optimal comment density, performance considerations, and integration with development workflow. Use when establishing commenting standards, addressing performance concerns, implementing Pseudocode Programming Process (PPP), or determining appropriate comment frequency.
Evaluate code layout quality based on accuracy, consistency, readability, and maintainability rather than aesthetics. Use when establishing coding standards, reviewing code formatting, or making decisions about layout conventions.
Apply proper indentation and spacing rules to code comments to enhance readability and maintain code visual structure. Use when writing or formatting comments within code blocks, or when establishing code style guidelines.
| name | self-documenting-code-checklists |
| description | Use this skill when writing, reviewing, or refactoring code to ensure it is self-documenting. Apply these checklists to routines, data naming, data organization, and overall code layout to improve code clarity and maintainability without relying on comments. |
Self-documenting code communicates its purpose through clear naming, structure, and organization rather than through comments. Use these checklists to evaluate and improve code clarity.
Apply this checklist when designing or reviewing functions, methods, and subroutines:
Action: If any item is "no," refactor the routine.
Apply this checklist when declaring or naming variables, constants, and types:
Action: Rename variables or introduce constants if magic numbers or ambiguous names are found.
Apply this checklist when organizing data access and structures:
Action: Refactor data structures or introduce intermediate variables to simplify logic.
Apply this checklist when reviewing code layout or high-level design:
Action: Format and simplify code if it is too "clever" or the layout is confusing.
