> Tips：有了 AI 之后，为函数自动写注释就显得极其简单，这里的功能可能也不太用得上了。

## 一、 koroFileHeader

### 1. 简介

这个插件是自动生成注释的，但是延迟会比较大，可配置项比较多。

### 2. 扩展安装

- Github 仓库为：[GitHub - OBKoro1/koro1FileHeader: VSCode 插件：自动生成，自动更新 VSCode 文件头部注释, 自动生成函数注释并支持提取函数参数，支持所有主流语言，文档齐全，使用简单，配置灵活方便，持续维护多年。 · GitHub](https://github.com/OBKoro1/koro1FileHeader)

- VSIX 下载

```shell
# https://marketplace.visualstudio.com/_apis/public/gallery/publishers/{发布者}/vsextensions/{插件名}/{版本号}/vspackage

https://marketplace.visualstudio.com/_apis/public/gallery/publishers/OBKoro1/vsextensions/korofileheader/4.9.3/vspackage
```

### 3. 扩展配置

[配置字段 · OBKoro1/koro1FileHeader Wiki](https://github.com/OBKoro1/koro1FileHeader/wiki/配置字段)：

```json
// 头部注释
"fileheader.customMade": {
    // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
    // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
    // 自动提取当前git config中的: 用户名、邮箱
    "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
    // "Author": "git config user.name", // 仅获取用户名
    // "Author": "git config user.email", // 仅获取邮箱
    // "Author": "OBKoro1", // 写死的固定值 不从git config中获取
    "Date": "Do not edit", // 文件创建时间(不变)
    // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
    "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
    // 由于编辑文件就会变更最后编辑时间，多人协作中合并的时候会导致merge
    // 可以将时间颗粒度改为周、或者月，这样冲突就减少很多。搜索变更时间格式: dateFormat
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    // 输出相对路径，类似: /文件夹名称/src/index.js
    "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
    // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
    "Description": "", // 介绍文件的作用、文件的入参、出参。
    // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
    // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
    "custom_string_obkoro1": "", 
    // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
    // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
    "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
    // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
},
// 函数注释
"fileheader.cursorMode": {
    "description": "", // 函数注释生成之后，光标移动到这里
    "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
    "return": "",
},
// 插件配置项
"fileheader.configObj": {
    "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
    "autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释
    "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
    "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
   // 自动添加头部注释黑名单
   "prohibitAutoAdd": [
      "json"
    ],
   "prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],
   "folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释
   "wideSame": false, // 头部注释等宽设置
   "wideNum": 13,  // 头部注释字段长度 默认为13
    "functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭
   // 头部注释第几行插入
    "headInsertLine": {
      "php": 2 // php文件 插入到第二行
    },
    "beforeAnnotation": {}, // 头部注释之前插入内容
    "afterAnnotation": {}, // 头部注释之后插入内容
    "specialOptions": {}, // 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
    "switch": {
      "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
    },
    "moveCursor": true, // 自动移动光标到Description所在行
    "dateFormat": "YYYY-MM-DD HH:mm:ss",
    "atSymbol": ["@", "@"], // 更改所有文件的自定义注释中的@符号
    "atSymbolObj": {}, //  更改单独语言/文件的@
    "colon": [": ", ": "], // 更改所有文件的注释冒号
    "colonObj": {}, //  更改单独语言/文件的冒号
    "filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \
    "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
    "writeLog": false, // 错误日志生成
    "CheckFileChange": false, // 单个文件保存时进行diff检查
    "createHeader": false, // 新建文件自动添加头部注释
    "useWorker": false, // 是否使用工作区设置
    "designAddHead": false, // 添加注释图案时添加头部注释
    "headDesignName": "random", // 图案注释使用哪个图案 
    "headDesign": false, // 是否使用图案注释替换头部注释
    // 自定义配置是否在函数内生成注释 不同文件类型和语言类型
    "cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释
    "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
    "functionParamsShape": ["{", "}"], // 函数参数外形自定义 
    // "functionParamsShape": "no type" 函数参数不需要类型
    "functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
    "functionTypeSymbol": "*", // 参数没有类型时的默认值
    "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
    "NoMatchParams": "no show param", // 没匹配到函数参数，是否显示@param与@return这两行 默认不显示param
    "functionParamAddStr": "", // 在 type param 后面增加字符串 可能是冒号，方便输入参数描述
    // 自定义语言注释，自定义取消 head、end 部分
    // 不设置自定义配置language无效 默认都有head、end
    "customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function" 
    "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
     // 自定义语言注释符号，覆盖插件的注释格式
    "language": {
        // js后缀文件
        "js": {
            "head": "/$$",
            "middle": " $ @",
            "end": " $/",
            // 函数自定义注释符号：如果有此配置 会默认使用
            "functionSymbol": {
              "head": "/******* ", // 统一增加几个*号
              "middle": " * @",
              "end": " */"
            },
            "functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
        },
       // 一次匹配多种文件后缀文件 不用重复设置
       "h/hpp/cpp": {
          "head": "/*** ", // 统一增加几个*号
          "middle": " * @",
          "end": " */"
        },
        // 针对有特殊要求的文件如：test.blade.php
        "blade.php":{
          "head": "<!--",
          "middle": " * @",
          "end": "-->",
        }
    },
 // 默认注释  没有匹配到注释符号的时候使用。
 "annotationStr": { 
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": false
    },
}
```

## 二、Doxygen Documentation Generator

### 1. 简介

这个插件可配置项较少，但是速度很快。

### 2. 扩展安装

- Github：[GitHub - cschlosser/doxdocgen: Generate doxygen documentation from source code in VS Code · GitHub](https://github.com/cschlosser/doxdocgen)

- VSIX 下载

```shell
# https://marketplace.visualstudio.com/_apis/public/gallery/publishers/{发布者}/vsextensions/{插件名}/{版本号}/vspackage

https://marketplace.visualstudio.com/_apis/public/gallery/publishers/cschlosser/vsextensions/doxdocgen/1.4.0/vspackage
```

### 3. 扩展配置

参考 [GitHub - cschlosser/doxdocgen: Generate doxygen documentation from source code in VS Code](https://github.com/cschlosser/doxdocgen?tab=readme-ov-file#config-options)：

```json
{
  "doxdocgen.c.triggerSequence": "dfun", // 触发方式，空行处敲 dfunc + Enter可以触发注释
}
```

## 三、Doxygen

### 1. 简介

Doxygen 并不是 vscode 插件，它是软件开发中广泛使用的文档生成工具。它自动化从源代码注释生成文档的过程，解析关于类、函数和变量的信息，生成 HTML 和 PDF 等格式的输出。通过简化和标准化文档流程，Doxygen 增强了跨不同编程语言和项目规模的协作与维护。

官网：[Doxygen homepage](https://www.doxygen.nl/index.html)

> Tips：
>
> - 中文主页：<https://doxygen.cpp.org.cn/>
> - Github 仓库：[GitHub - doxygen/doxygen: Official doxygen git repository](https://github.com/doxygen/doxygen)

### 2. 下载安装

可以去官网下：[Doxygen download](https://www.doxygen.nl/download.html)：

<img src="./LV505-生成注释/img/image-20250529125131443.png" alt="image-20250529125131443"  />

要是被墙了可以在这里下：

- [Doxygen download | SourceForge.net](https://sourceforge.net/projects/doxygen/?source=dlp)
- [Tags · doxygen/doxygen · GitHub](https://github.com/doxygen/doxygen/tags)

### 3. 基本用法

#### 3.1 特定格式的批注撰写

```c
/**
 * @file   main.c
 * @brief  This is the test demo
 * @author doxygen demo
 * @date   2025-05-29
 */

/**
 * @brief   
 * @note    
 * @param   {unsigned char} m
 * @param   {unsigned char} n
 * @return  {*}
 */
unsigned int pow_demo(unsigned char m,unsigned char n)
{
	unsigned int result = 1;	 
	while(n--) result *= m;    
	return result;
}

/**
 * @brief   
 * @note    
 * @param   {int} argc
 * @param   {char**} argv
 * @return  {*}
 */
int main(int argc, char** argv)
{
	pow_demo();
    return 0;
}
```

#### 3.2 生成配置文件的模板文件

生成配置文件的模板文件，名为 Doxyfile，在工程根目录下执行：

```shell
doxygen -g
```

#### 3.3 修改配置文件

根据需要手动修改配置文件，例如：

```shell
# 修改点EXTRACT_ALL的值改成YES，如下，表示提取所有类和函数
EXTRACT_ALL            = YES
```

常用的需要设置的主要分为：文档格式、项目输入文件、输出文档类型：

```shell
PROJECT_NAME     : 项目名称。
PROJECT_VERSION  : 项目版本。
PROJECT_LANGUAGE : 项目使用的语言。
INPUT            : 包含源代码文件的目录。
FILE_PATTERNS    : 匹配哪些文件应该被 Doxygen 处理。
EXTRACT_ALL      : 是否提取所有类和函数。
GENERATE_LATEX   : 是否生成 LaTeX 格式的文档。
HAVE_DOT         : 是否可以使用 Graphviz 的 dot 工具来生成图表。
CALL_GRAPH       : 是否生成函数调用图。
CALLER_GRAPH     : 是否生成被调用函数图。
WARNINGS         : 是否显示警告信息。
SOURCE_BROWSER   : 是否显示源代码浏览器。
INLINE_SOURCES   : 是否在 HTML 文档中内联显示源代码。
STRIP_CODE_COMMENTS: 是否去除源代码中的注释。
GENERATE_HTML    : 是否生成 HTML 格式的文档。
HTML_OUTPUT      : HTML 文档的输出目录。
HTML_FILE_EXTENSIONS: HTML 文件扩展名。
GENERATE_XML     : 是否生成 XML 格式的文档。
XML_OUTPUT       : XML 文档的输出目录。
XML_PROLOGUE     : XML Prologue 的内容。
GENERATE_LATEX   : 是否生成 LaTeX 格式的文档。
LATEX_OUTPUT     : LaTeX 文档的输出目录。
HAVE_BIBTEX      : 是否可以生成参考文献。
BIB_LATEX_STYLE  : 参考文献的 LaTeX 样式。
EXT_CALL_GRAPH   : 是否为外部函数生成调用图
```

#### 3.4 生成文档

根目录下执行

```shell
doxygen
```

上面都是默认配置，所以将会在输出目录(当前目录)生成 `html`、`latex` 目录。

<img src="./LV505-生成注释/img/image-20250529131404852.png" alt="image-20250529131404852"  />

- `html` 目录中文件如下：

<img src="./LV505-生成注释/img/image-20250529131029563.png" alt="image-20250529131029563"  />

其中 index.html 就是主页，从浏览器打开即可。

- `latex` 目录文件如下：

<img src="./LV505-生成注释/img/image-20250529131719952.png" alt="image-20250529131719952"  />

#### 3.5 生成 pdf

上面要是生成了 `latex` 目录，我们还可以进入 `latex` 目录，执行：

```shell
make
```

还会生成名为 refman.pdf 的 pdf 文件。