---
title: "AI 从代码中自动生成注释文档"
description: "程序员最讨厌的两件事：自己写注释别人不写注释Mintlify 的插件终于可以把我们从痛苦的死循环中解救出来了"
date: 2022-06-25T02:58:32Z
canonical: https://xiaobox.github.io/p/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/
author: 小盒子
categories: ["AI"]
source: https://mp.weixin.qq.com/s/ZceParJ9RcM9urSo7hGN_Q
license: CC BY-NC-SA 4.0
license_url: https://creativecommons.org/licenses/by-nc-sa/4.0/
---

# AI 从代码中自动生成注释文档

程序员最讨厌的两件事：

1.  自己写注释
2.  别人不写注释

Mintlify 的插件终于可以把我们从痛苦的死循环中解救出来了。

Mintlify 利用 AI 技术从代码中自动生成注释文档

![Image](https://pub-f29bf2b53160470c9a85250116509a24.r2.dev/post/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/001-0155f15c.jpg)

注意 **it's free**

但谁知道呢，也许过一阵子就像  github 的 `Copilot` 一样开始收费了也说不定。

## 来个Demo

比如我这段简单的`二分查找` 程序片段：

![Image](https://pub-f29bf2b53160470c9a85250116509a24.r2.dev/post/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/002-29a48d5a.jpg)

分别看下 `Mintlify` 为它生成的注释，注意：**它可以生成多语言的，有英文的也有中文的**

![Image](https://pub-f29bf2b53160470c9a85250116509a24.r2.dev/post/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/003-0c85aa99.jpg)

![Image](https://pub-f29bf2b53160470c9a85250116509a24.r2.dev/post/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/004-b660c51b.jpg)

![Image](https://pub-f29bf2b53160470c9a85250116509a24.r2.dev/post/2022-06-25-ai-cong-dai-ma-zhong-zi-dong-sheng-cheng-zhu-shi-wen-dang/005-29c35973.png)

上面这些都是自动生成的，从结果看是基于程序进行的翻译，比较啰嗦，但还算准确。

## 应用

好啦，那剩下的事情就是把你写完的程序一键生成注释，然后一份带有良好（啰嗦）注释的代码就编写完成了，如果你的团队统计代码和注释行数（哪个团队这么SB，告诉我，避个坑），那么又愉快地完成了`KPI`。

开个玩笑 ，良好的代码注释，不但有利于别人阅读，更有利于维护，有时候时间长了，我们自己都不知道写的是什么玩意，我有时候看到一大段程序没有注释还写的特别绕的时候就开始骂娘了：“这TM写的什么玩意儿”，讽刺的是，有些时候，那程序是我自己写的。哈哈。

都说优秀的代码可以做到`自解释`，不用写注释也看得懂，对，那是优秀的代码，在你还不能写成那样的代码之前，**写注释吧孩子**，先保证你不会被团队的同学骂娘再说。

## 提示

如安装插件或使用过程中遇到网络问题，请通过科学上网自行解决。如这玩意（https://www.mintlify.com/）开始收费了，当我没说。