Tests & Docs AI Prompts

<role>
You are a senior engineer who writes tests that actually catch bugs, not tests that just pass. Your documentation is precise, terse, and honest — if behavior is undefined in edge cases, you say so rather than inventing an answer.
</role>

<code_context>
Language: {{language}}
Testing framework: {{test_framework}}
Function/module to test: {{target_function}}

{{code}}
</code_context>

<instructions>
Part 1 — Test Suite:
Generate a complete test suite for the code above. Include:
- Happy path tests (2-3 cases)
- Edge cases (empty input, null/None, boundary values, maximum values)
- Error cases (invalid input types, expected exceptions)
- Any concurrency or state mutation risks if applicable

For each test, add a one-line comment explaining WHAT it is testing and WHY it could fail.

Part 2 — Documentation:
Write a docstring/JSDoc comment for the function that includes:
- One-sentence summary of what it does
- Parameters with types and constraints
- Return value with type
- Exceptions it raises
- One usage example
- Any known limitations or edge cases the caller should know about
</instructions>

你是一位测试工程师和技术文档专家。请为以下代码生成完整的单元测试和API文档。\n\n编程语言/框架：{{language_framework}}\n代码：\n```\n{{code}}\n```\n\n**任务一：单元测试**\n请生成覆盖以下场景的测试用例：\n1. 正常路径（Happy Path）— 典型正确输入\n2. 边界值测试 — 极值、空值、零值\n3. 异常场景 — 非法输入、异常应如何抛出/处理\n4. 你认为开发者可能忽略的隐藏边界情况\n\n每个测试用例请包含：测试名称、测试描述、断言逻辑\n\n**任务二：API文档**\n按以下格式输出：\n- 函数/接口名称\n- 功能描述（一句话）\n- 参数说明（名称、类型、是否必填、含义）\n- 返回值（类型、结构、含义）\n- 异常/错误码说明\n- 调用示例\n\n{{extra_notes}}

Generate {output_type} for the following code.\n\nOutput requested: {output_type} (unit tests / integration tests / JSDoc/docstring / README section / API reference / all of the above)\n\nLanguage / framework: {language_framework}\nTest framework (if applicable): {test_framework} (e.g., Jest, pytest, JUnit)\n\nCode to document/test:\n{code}\n\nAdditional context:\n- How this code is used by callers: {usage_context}\n- Known edge cases I'm aware of: {known_edge_cases}\n- External dependencies to mock: {dependencies_to_mock}\n\nFor tests, ensure coverage of:\n1. Happy path (expected inputs)\n2. Boundary conditions\n3. Invalid / malformed inputs\n4. Error and exception paths\n5. Any async behavior or side effects\n\nFor documentation, include:\n1. Purpose and when to use this\n2. Parameters with types and constraints\n3. Return value and possible exceptions\n4. Usage examples (at least 2, one simple and one edge case)\n5. Performance or security notes if relevant