简介

AI文档生成利用大模型从代码自动生成API文档、README、代码注释和变更日志，保持文档与代码同步。

从代码生成API文档

# AI从Controller代码生成API文档
def generate_api_doc(code, format="markdown"):
    response = client.chat.completions.create(
        model="gpt-4",
        messages=[
            {"role": "system", "content": f"你是技术文档专家。根据代码生成{format}格式的API文档，包含接口路径、方法、参数、返回值、示例。"},
            {"role": "user", "content": f"代码:\n{code}"}
        ],
        max_tokens=1000
    )
    return response.choices[0].message.content

controller_code = """
@RestController
@RequestMapping("/api/products")
public class ProductController {
    @GetMapping("/{id}")
    public CommonResult<ProductVO> getProduct(@PathVariable Long id) {
        return success(productService.getProduct(id));
    }
    
    @PostMapping
    public CommonResult<Long> createProduct(@Valid @RequestBody ProductCreateReqVO req) {
        return success(productService.createProduct(req));
    }
}
"""

doc = generate_api_doc(controller_code)
print(doc)

生成README

# AI生成项目README
def generate_readme(project_info):
    response = client.chat.completions.create(
        model="gpt-4",
        messages=[
            {"role": "system", "content": "生成专业的README.md，包含项目介绍、功能特性、安装步骤、使用方法、技术栈、目录结构、贡献指南。"},
            {"role": "user", "content": f"项目信息: {project_info}"}
        ],
        max_tokens=1500
    )
    return response.choices[0].message.content

info = "AI编程学习平台，Spring Boot + React，功能包括教程管理、在线练习、AI辅助编程"
readme = generate_readme(info)
with open("README.md", "w", encoding="utf-8") as f:
    f.write(readme)

生成代码注释

# AI为无注释代码添加注释
def add_comments(code, language="java"):
    response = client.chat.completions.create(
        model="gpt-4",
        messages=[
            {"role": "system", "content": f"为{language}代码添加详细的注释。保留原始代码，只添加注释。包括类注释、方法注释、关键逻辑注释。"},
            {"role": "user", "content": code}
        ],
        max_tokens=2000
    )
    return response.choices[0].message.content

uncommented = """
public List<Order> findOrdersByUser(Long userId, LocalDate startDate, LocalDate endDate) {
    return orderMapper.selectList(new LambdaQueryWrapper<Order>()
        .eq(Order::getUserId, userId)
        .between(Order::getCreateTime, startDate, endDate)
        .orderByDesc(Order::getCreateTime));
}
"""
print(add_comments(uncommented))

小结

AI文档生成能保持文档与代码的同步更新。API文档建议在CI流程中自动生成，README在项目初始化时生成。代码注释添加需人工审查准确性，避免AI产生误导性注释。

创意AI编程入门