需严格按Fitten Code规范将口语化注释转为结构化文档注释:三重双引号包裹,@param/@return/@raises逐行标注,中文描述,禁用额外解释;批量处理须用fitten-docs-cli 1.3.7注入骨架后AI填充并人工校验。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要把散乱、口语化、不统一的代码注释,快速转成Fitten Code规范要求的结构化文档注释,让函数说明、参数、返回值、异常等字段清晰可读,且适配团队协作与自动化文档生成工具。
确认Fitten Code注释标准格式
打开团队内部《Fitten Code 开发规范 v2.4》PDF或Confluence页面,定位「文档注释(Docstring)」章节。重点核对三要素:【必须使用三重双引号 """ 包裹】,参数必须按 @param name: type - description 格式逐行列出,返回值用 @return: type - description,异常用 @raises ExceptionType: reason。不满足这三条的注释一律视为无效。
检查当前项目中已通过CI校验的.py文件(如 src/utils/validator.py),复制一个合规的函数注释块作为模板备用——不要凭记忆写,模板错一个符号就会导致Sphinx构建失败。
用VS Code + Copilot 快速重构单个函数注释
方法一:交互式补全
将光标置于待处理函数名正上方空行,输入 """ 并回车,Copilot会自动建议完整Docstring。若首行提示不准确,按 Ctrl+Enter(Windows/Linux)或 Cmd+Enter(macOS)唤出建议面板,从中选择语义最贴近的条目。这一步操作起来很简单,直接选中即可插入。
方法二:指令驱动重写
选中现有注释块(含函数签名),右键→「Ask Copilot」→输入指令:重写为Fitten Code标准Docstring,包含@param、@return、@raises,语言为中文,不添加额外解释。注意:【必须明确限定“不添加额外解释”,否则Copilot会擅自补充示例或注意事项,破坏格式一致性】。
Fitten Code 1.0.3是一款由清华博士团队打造的AI编程助手,基于国产计图(Jittor)深度学习框架开发。它支持VS Code、JetBrains系列等主流IDE及80多种编程语言。核心功能包括智能代码补全、注释生成、代码解释、Bug检测、单元测试生成等,旨在全方位提升开发效率。该工具对个人用户免费开放。
批量处理整个Python模块的注释
第一步:安装并配置 fitten-docs-cli 工具
在项目根目录终端运行:pip install fitten-docs-cli==1.3.7。版本必须为 【1.3.7】,低版本不支持 @raises 字段识别,高版本尚未通过安全审计。
第二步:生成初始注释骨架
执行命令:fitten-docs-cli inject --module src/models/user.py --inplace。该命令会在所有无Docstring的函数上方插入占位注释,含标准字段但描述为空。已有注释的函数不会被覆盖,避免误删人工撰写内容。
第三步:AI填充描述字段
用VS Code打开 user.py,安装插件「Docstring Generator Pro」,启用后对每个新注入的空注释块按 Alt+Shift+D,选择「Fitten Style (CN)」模板。插件会基于函数名、参数名、类型提示和函数体逻辑自动生成中文描述——如果函数体含正则表达式或加密逻辑,它可能把 token 误判为“令牌”而非“临时访问凭证”,需人工修正。

















