When does this skill suggest skipping documentation?

Documentation should be skipped for trivial methods, self-explanatory parameters (like width or height), and cases where the method name and types provide all necessary context.

Does it support specific formatting for array types?

Yes, it specifically prompts for array content documentation, such as using @return string[] to clarify what an array contains.

What is the primary goal of the php-doc skill?

The primary goal is to ensure that PHP documentation adds value. It follows the rule of never duplicating signature information that is already obvious from the code itself.

How does it handle PHP exception documentation?

It encourages using natural language and active voice, focusing on the problem rather than technical jargon, and avoiding phrases like 'Exception that is thrown when'.

PHP Documentation Standards

Name: PHP Documentation Standards
Author: nette

bynette

•

Developer Tools

Enforces concise, high-quality PHPDoc standards to improve code readability without redundant signature duplication.

The php-doc skill for Claude Code provides a rigorous framework for writing clean and meaningful PHP documentation based on the Nette style guide. It emphasizes a 'Golden Rule' of avoiding documentation that merely repeats what is already clear from the code signature, ensuring every comment adds genuine value. The skill automates best practices for property annotations, method descriptions, and exception handling, utilizing specific formatting rules like two-space alignment and active-voice phrasing. This tool is essential for teams looking to maintain a professional, standardized, and noise-free PHP codebase.

Key Features

0129 GitHub stars

02Standardizes formatting for parameters, return values, and property annotations

03Enforces the 'Golden Rule' of avoiding redundant signature information

04Implements specific Nette-style formatting like two-space alignment for tags

05Guides consistent phrasing for exception documentation using active voice

06Identifies when to skip documentation for self-explanatory code

Use Cases

01Standardizing existing PHPDoc blocks across a legacy codebase to match modern standards

02Documenting complex PHP methods where array types or business logic need clarification

03Ensuring exception messages are descriptive and user-focused rather than overly technical

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add nette/claude-code php-doc

For use in Claude.ai and ChatGPT

Download Skill