代码开发

在代码开发场景中，AI大语言模型展现出强大的辅助能力，能够帮助开发者完成代码生成、调试、审查、优化以及文档撰写等任务。掌握针对代码场景的提示词设计方法，能够显著提升开发效率，减少重复性工作。

一、代码场景的核心提示词要素

与写作场景不同，代码场景的提示词设计需要包含更明确的技术上下文：

1. 编程语言与框架：明确指定使用的编程语言（如Python、JavaScript、TypeScript等）以及框架版本（如React 18、Django 4.x）。AI对不同语言的语法习惯和最佳实践有不同的知识储备。

2. 功能需求描述：清晰描述需要实现的具体功能，包括输入、输出和核心逻辑。避免模糊的功能描述，如“帮我写个排序函数”应改为“帮我写一个Python函数，输入是一个整数列表，输出是按升序排列的新列表，不要使用内置的sort()方法”。

3. 约束条件：说明性能要求、兼容性要求、安全性要求等限制条件。例如“需要在Python 3.8以上版本运行”“不能使用第三方库”“需要处理空列表输入”等。

二、五大代码开发场景详解

场景1：代码生成

代码生成是最常用的场景。有效的提示词结构应包含：功能描述+技术栈+示例输入输出。

实战演示：

提示词：请用Python写一个函数，实现字符串反转功能。要求：
1. 输入参数为英文字符串
2. 返回反转后的字符串
3. 处理空字符串的情况，返回空字符串
4. 不使用Python内置的reverse()方法

AI输出示例：

def reverse_string(s: str) -> str:
    """反转输入字符串"""
    if not s:  # 处理空字符串
        return ""
    return s[::-1]

优化点评：AI生成的代码逻辑正确，但在实际生产环境中，建议添加类型注解和更详细的文档说明。可以进一步要求：“添加完整的类型注解和Google风格的docstring”。

场景2：代码调试

调试场景需要提供详细的错误上下文。有效的提示词应包含：错误信息+相关代码+期望行为。

实战演示：

提示词：我的Python代码报错了，错误信息是"IndexError: list index out of range"，相关代码如下：

numbers = [1, 2, 3]
for i in range(5):
    print(numbers[i])

请帮我分析错误原因并修复代码。

AI输出示例：
问题分析：循环范围是0到4，但列表只有3个元素（索引0-2），当i=3时访问numbers[3]越界。

修复方案：

numbers = [1, 2, 3]
for i in range(len(numbers)):
    print(numbers[i])

或者更Pythonic的方式：

for num in numbers:
    print(num)

场景3：代码审查

代码审查场景应明确审查重点，如安全性、性能、可读性、最佳实践等。

实战演示：

提示词：请审查以下Python代码，重点关注：1）安全性问题 2）性能隐患 3）代码可读性。请逐条列出问题并给出改进建议。

def get_user_data(user_id):
    query = f"SELECT * FROM users WHERE id = {user_id}"
    result = db.execute(query)
    return result

AI输出示例：
问题列表：
1. SQL注入风险：直接拼接用户输入到SQL语句中，这是严重的安全漏洞。
2. 缺乏错误处理：数据库连接失败或查询异常时没有处理。
3. 使用SELECT *：应该明确指定需要的字段，避免不必要的数据传输。

改进建议：

def get_user_data(user_id: int) -> dict | None:
    """获取用户数据"""
    try:
        query = "SELECT id, name, email FROM users WHERE id = %s"
        result = db.execute(query, (user_id,))
        return result.fetchone()
    except db.Error as e:
        logging.error(f"数据库查询失败: {e}")
        return None

场景4：代码优化

优化场景应指明优化方向：性能优化、内存优化、简洁性提升、可读性改进等。

实战演示：

提示词：以下JavaScript函数用于检查字符串是否为回文串，请帮我优化，要求：1）提升性能 2）减少空间复杂度 3）保持代码可读性。

function isPalindrome(str) {
    const cleaned = str.toLowerCase().replace(/[^a-z0-9]/g, '');
    const reversed = cleaned.split('').reverse().join('');
    return cleaned === reversed;
}

AI输出示例：

function isPalindrome(str: string): boolean {
    // 双指针优化：只需遍历一半
    const cleaned = str.toLowerCase().replace(/[^a-z0-9]/g, '');
    let left = 0;
    let right = cleaned.length - 1;

    while (left < right) {
        if (cleaned[left] !== cleaned[right]) {
            return false;
        }
        left++;
        right--;
    }
    return true;
}

优化说明：时间复杂度从O(n)降至O(n/2)，空间复杂度从O(n)降至O(1)。

场景5：技术文档撰写

文档生成包括注释生成、API文档、README文件等。提示词应指明文档风格和详细程度。

实战演示：

提示词：请为以下函数生成完整的Google风格文档注释，包括参数说明、返回值说明、异常说明和使用示例：

def calculate_discount(price, discount_rate, min_price=0):
    final_price = price * (1 - discount_rate)
    return max(final_price, min_price)

AI输出示例：

def calculate_discount(price: float, discount_rate: float, min_price: float = 0) -> float:
    """计算打折后的价格。

    Args:
        price: 商品原价，必须为正数
        discount_rate: 折扣率，范围0-1之间的小数
        min_price: 最低价格保护，默认为0

    Returns:
        打折后的价格，若低于最低价格则返回最低价格

    Raises:
        ValueError: 当price为负数或discount_rate超出0-1范围时

    Example:
        >>> calculate_discount(100, 0.2)
        80.0
        >>> calculate_discount(50, 0.9, min_price=10)
        10.0
    """
    if price < 0:
        raise ValueError("原价不能为负数")
    if not 0