Fitten_Code批量代码注释：一键为整个类或模块加上中文规范注释

Fitten Code插件可一键为Python类和函数生成符合中文开发规范的文档字符串：定位class或def行右键选择对应命令，自动填充类说明、参数、返回值等内容，支持自定义模板与作者信息。

你需要为一个已有Python类快速补全符合中文开发规范的文档字符串和方法注释，避免逐行手敲、格式不统一、遗漏参数说明等问题。

安装并启用Fitten Code插件

打开VS Code → 左侧扩展商店（Ctrl+Shift+X）→ 搜索“Fitten Code”→ 点击“Install”完成安装。

安装后无需重启，插件会自动激活。若右键菜单未出现“Add Docstring”选项，请检查是否已启用Python语言支持（需已安装Python扩展）。

为整个Python类一键生成规范中文注释

在编辑器中打开目标.py文件 → 将光标定位在class关键字所在行（例如class DataProcessor:）→ 右键 → 选择“Fitten Code: Add Docstring for Class”。

插件会自动识别类名、继承关系、所有public方法，并生成符合《阿里Java开发手册》中文注释风格的文档结构：类说明、作者、创建时间、功能概述、属性列表、方法摘要。生成的注释使用三重双引号包裹，缩进与class对齐。

这一步不可逆——如果类已有docstring，Fitten Code默认会【覆盖原有文档字符串】，不会追加或合并。如需保留旧内容，请先手动备份原docstring。

为模块级函数或独立函数添加中文注释

方法一：光标停在def行（如def load_config(path: str) -> dict:）→ 右键 → “Fitten Code: Add Docstring for Function”。

方法二：选中整段函数代码（含def行和首行缩进）→ 右键 → 同样选择该命令。两种方式结果一致，但方法二更稳妥，避免因光标偏移导致识别失败。

生成内容包含：函数功能描述、参数类型与含义（自动提取类型提示）、返回值说明、异常说明（若函数体含raise语句则自动标注）。参数名与函数签名严格对应，错一个字母都会导致注释中参数项缺失。

自定义注释模板（适配团队规范）

按下Ctrl+Shift+P → 输入“Preferences: Open Settings (JSON)” → 在settings.json中添加：

"fittenCode.docstringTemplate": "zh-cn-class"

可选值包括：zh-cn-class（类模板）、zh-cn-func（函数模板）、zh-cn-module（模块顶部模板）。修改后立即生效，无需重启。

若团队要求在作者栏自动填入工号而非姓名，需额外配置"fittenCode.author": "A123456"。此项必须手动设置，插件不会从系统或Git中自动读取。