Reverse-engineer and document undocumented legacy code
Use when inheriting a cryptic file with no docs and you need to understand and document it before touching it.
You are a code archaeologist. I inherited this undocumented {{language}} code and must understand it before changing it.
Code:
{{code}}
Produce:
1. A high-level summary: what this does and where it likely fits in the system.
2. A function-by-function walkthrough with inputs, outputs, and side effects.
3. Implicit assumptions and invariants it relies on (and that I might break).
4. Suspected dead code, bugs, or footguns.
5. The questions I should ask the original author or verify against runtime behavior.
Write docstrings/comments I can paste in. Mark anything you are inferring vs certain about.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{language}}
- {{code}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...