$ recombobulate _
home / tips / generate-phpdoc-and-jsdoc-comments-across-your-codebase
129

Generate PHPDoc and JSDoc Comments Across Your Codebase

recombobulate @recombobulate · Mar 26, 2026 · Workflows
generate-phpdoc-and-jsdoc-comments-across-your-codebase

Documentation is one of those tasks that's easy to skip when you're shipping fast. Claude can write accurate docblocks in bulk by reading your code and inferring types, intent, and edge cases from context.

Generate complete PHPDoc comments for every public method and property in
src/Services/ — follow PSR-5 conventions and include @param, @return,
and @throws tags where applicable.

Claude scans the implementation, looks at how each method is called, and writes documentation that reflects what the code actually does — not just what the signature says. It's much more accurate than auto-generated stubs from IDE plugins.

# TypeScript / JSDoc
Add JSDoc comments to all exported functions in src/api/.
Include @param types, @returns, and @example blocks for every public-facing method.
Use TypeDoc-compatible syntax.

# Python
Generate Google-style docstrings for every undocumented class and function
in app/services/. Include Args, Returns, and Raises sections.

# Targeting specific pain points
Find every function in src/ that has no docblock and is longer than 20 lines,
then write JSDoc for each one.

You can run this as a one-off cleanup session or add it as a pre-PR checklist step in your CLAUDE.md.

Stop treating documentation as optional — let Claude write it while you focus on features.

~/recombobulate $ tip --comments --count=0

Log in to leave a comment.

~/recombobulate $ tip --related --limit=3
0
Run Claude Code in GitHub Actions to Automatically Review Every Pull Request

Set up Claude Code as an automated reviewer in your CI pipeline — on every pull request, it reads the diff, checks for bugs, security issues, missing tests, and convention violations, then posts its findings as a PR comment. Your human reviewers get a head start because the obvious issues are already flagged before they look.

recombobulate @recombobulate · 1 month ago
0
Ask Claude to Build a Deployment Checklist from Your Actual Infrastructure

Before deploying, tell Claude to read your project — migrations, environment variables, queue workers, scheduled tasks, caching, third-party integrations — and generate a deployment checklist that's specific to your app. Not a generic "did you run migrations?" list, but one that knows YOUR infrastructure and catches the things YOUR deploy can break.

recombobulate @recombobulate · 1 month ago
0
Ask Claude to Generate a README from Your Actual Codebase — Not a Template

Instead of writing a README from memory or copying a template, tell Claude to read your project and generate one that's actually accurate — real setup instructions from your config, real architecture from your directory structure, real API examples from your routes, and real prerequisites from your dependency files.

recombobulate @recombobulate · 1 month ago