$ recombobulate _
home / tips / use-claude-to-document-a-function-as-you-write-it
140

Use Claude to Document a Function as You Write It

recombobulate @recombobulate · Mar 25, 2026 · Workflows
use-claude-to-document-a-function-as-you-write-it

Documentation is one of those things everyone knows matters but always defers until later. Claude makes it easy to do it right now, in the same breath as writing the code.

After writing a function, ask Claude to document it:

Add PHPDoc to this method. Include @param and @return types,
a one-line summary, and a @throws annotation if applicable.

public function processRefund(Order $order, float $amount): RefundResult
{
    // ...
}

Claude will produce a complete block that matches the conventions of your language and framework — including edge cases in the description that it infers from reading the implementation.

You can document a whole file at once:

Add docstrings to every public function in this file.
Use Google-style Python docstrings with Args, Returns, and Raises sections.
Don't change any of the implementation code.

This constraint — "don't change the implementation" — is important to include so Claude stays focused on documentation only.

For TypeScript, you can ask Claude to infer @example blocks based on how the function is called elsewhere in the file, or to flag functions whose signatures are ambiguous enough that the docs need a usage note.

Writing the code and the docs together is always faster than going back later — and Claude makes it nearly effortless.

~/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