Fitten Code 可生成结构清晰、合规可用的 Markdown 技术文档:需启用插件、配置本地模型并登录;支持右键单函数注释生成或 Ctrl+Alt+C 对话式跨文件整合;批量 README 需先导出 XML 再转 Markdown;须修复空行缺失、代码块标识错误及特殊字符转义问题。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让 Fitten Code 基于现有代码自动生成结构清晰、格式合规、可直接用于团队知识库的 Markdown 技术文档,而不是零散注释或无法渲染的碎片文本。
确认插件状态与模型配置
打开 VSCode,点击左侧活动栏 Extensions 图标 → 在搜索框输入 Fitten Code → 确认已安装且状态为 “Enabled”。
点击左下角 Fitten Code 图标 → 进入设置页 → 检查 “Model Provider” 是否设为本地可用模型(如 Qwen3-4B 或 DeepSeek-R1),【避免使用默认云端模型,否则生成内容可能含敏感信息外泄风险】。
若未登录,必须完成微信或邮箱登录;未登录状态下所有生成功能将被禁用。
从函数/类出发生成模块级文档
方法一:右键触发(推荐用于单个核心单元)
在编辑器中选中一个完整函数或 class 定义块 → 右键 → 选择 “Fitten Code – 生成注释” → 等待 AI 输出带层级标题、参数说明、返回值和示例的注释块 → 将该注释块复制到新文件中,手动包裹进 ```csharp 或对应语言代码块。
方法二:对话驱动(适合跨文件整合)
按 Ctrl+Alt+C 打开对话窗口 → 输入:“请基于以下 C# 类生成一份符合 Microsoft Learn Markdown 最佳实践的技术文档,包含:① 概述段落 ② 属性列表(含类型与用途) ③ 方法表格(方法名|参数|作用|返回值)④ 使用示例代码块”,然后粘贴目标类的全部源码 → 点击发送。
通过 jina.ai 将网页抓取为精简的 markdown,用于在需要获取 URL 并获取压缩的 markdown 内容以节省 token。触发词 l...
注意:AI 会自动识别 public 成员并忽略私有字段,但若类中含 [Obsolete] 或 [JsonIgnore] 等特性,需在提示词末尾追加“请保留所有特性说明”。
批量生成项目 README.md
第一步:在终端中执行 dotnet msbuild /t:GenerateDocumentation /p:Configuration=Release(前提是项目已集成 DocFX 或 SAAS 工具链),导出 XML 文档文件。
第二步:新建空白 readme.md 文件 → 将 XML 中的 <summary> 和 <remarks> 内容整理为纯文本列表 → 全选该文本 → 按 Ctrl+Alt+G → 输入提示词:“将以下内容转为标准 Markdown 格式:标题用 # 和 ## 分级,列表用 -,代码段用 ``` 包裹,中文标点全角,每行不超过 100 字符,禁止使用 HTML 标签”。
第三步:检查生成结果中是否出现 **参数**:`inputPath`(string) 这类混合格式 —— 若有,说明 AI 误将参数名当强调处理,需手动替换为 `inputPath` 并删除星号。
这一步操作起来很简单,直接把文件拖进去就行。
修复常见渲染异常
生成的 Markdown 若在 GitHub 或 Docsify 中显示错乱,大概率是空行缺失或特殊字符未转义。
打开生成的 .md 文件 → 安装 VSCode 插件 Markdown Preview Mermaid Support → 按 Ctrl+Shift+V 预览实时渲染效果。
重点检查:
• 表格前后是否有空行(无空行则表格不渲染)
• 代码块三重反引号后是否紧跟语言标识(如 ```csharp,不能写成 ``` cs)
• 用户输入含 _ 或 * 的字符串(如 user_name)是否被误解析为斜体 —— 此时需改为 \_user\_name 或用反引号包裹为 `user_name`。
【切勿用 Encoding.UTF8 默认构造写入文件,必须显式指定 new UTF8Encoding(encoderShouldEmitUTF8Identifier: false)】
















