当前位置:网站首页>AI 从代码中自动生成注释文档
AI 从代码中自动生成注释文档
2022-07-05 20:31:00 【小盒子】
程序员最讨厌的两件事:
自己写注释 别人不写注释
Mintlify 的插件终于可以把我们从痛苦的死循环中解救出来了。
Mintlify 利用 AI 技术从代码中自动生成注释文档
注意 it's free
但谁知道呢,也许过一阵子就像 github 的 Copilot
一样开始收费了也说不定。
来个Demo
比如我这段简单的二分查找
程序片段:
分别看下 Mintlify
为它生成的注释,注意:它可以生成多语言的,有英文的也有中文的
上面这些都是自动生成的,从结果看是基于程序进行的翻译,比较罗嗦,但还算准确。
应用
好啦,那剩下的事情就是把你写完的程序一键生成注释,然后一份带有良好(啰嗦)注释的代码就编写完成了,如果你的团队统计代码和注释行数(哪个团队这么SB,告诉我,避个坑),那么又愉快地完成了KPI
。
开个玩笑 ,良好的代码注释,不但有利于别人阅读,更有利于维护,有时候时间长了,我们自己都不知道写的是什么玩意,我有时候看到一大段程序没有注释还写的特别绕的时候就开始骂娘了:“这TM写的什么玩意儿”,讽刺的是,有些时候,那程序是我自己写的。哈哈。
都说优秀的代码可以做到自解释
,不用写注释也看得懂,对,那是优秀的代码,在你还不能写成那样的代码之前,写注释吧孩子,先保证你不会被团队的同学骂娘再说。
提示
如安装插件或使用过程中遇到网络问题,请通过科学上网自行解决。如这玩意(https://www.mintlify.com/)开始收费了,当我没说。
边栏推荐
- Notes on key vocabulary in the English original of the biography of jobs (12) [chapter ten & eleven]
- Some problems encountered in cocos2d-x project summary
- Leetcode skimming: binary tree 10 (number of nodes of a complete binary tree)
- 无卷积骨干网络:金字塔Transformer,提升目标检测/分割等任务精度(附源代码)...
- Reinforcement learning - learning notes 4 | actor critical
- Mongodb basic exercises
- Leetcode (347) - top k high frequency elements
- Hongmeng OS' fourth learning
- Schema and model
- A way to calculate LNX
猜你喜欢
PyTorch 1.12发布,正式支持苹果M1芯片GPU加速,修复众多Bug
如何形成规范的接口文档
Welcome to the game and win rich bonuses: Code Golf Challenge officially launched
Hongmeng OS' fourth learning
信息学奥赛一本通 1339:【例3-4】求后序遍历 | 洛谷 P1827 [USACO3.4] 美国血统 American Heritage
Frequent MySQL operations cause table locking problems
Leetcode brush question: binary tree 14 (sum of left leaves)
实操演示:产研团队如何高效构建需求工作流?
欢迎来战,赢取丰厚奖金:Code Golf 代码高尔夫挑战赛正式启动
Fundamentals - configuration file analysis
随机推荐
js方法传Long类型id值时会出现精确损失
Composition of applet code
How to form standard interface documents
Frequent MySQL operations cause table locking problems
National Eye Care Education Conference, 2022 the Fourth Beijing International Youth eye health industry exhibition
Fundamentals - configuration file analysis
2022 Beijing eye health products exhibition, eye care products exhibition, China eye Expo held in November
如何形成规范的接口文档
Simple understanding of interpolation search
sort和投影
Rainbond 5.7.1 支持对接多家公有云和集群异常报警
基础篇——配置文件解析
CCPC 2021 Weihai - G. shinyruo and KFC (combination number, tips)
kubernetes资源对象介绍及常用命令(五)-(ConfigMap&Secret)
插值查找的简单理解
本季度干货导航 | 2022年Q2
Notes on key vocabulary in the English original of the biography of jobs (12) [chapter ten & eleven]
Leetcode brush question: binary tree 13 (the same tree)
Leetcode skimming: binary tree 17 (construct binary tree from middle order and post order traversal sequence)
实操演示:产研团队如何高效构建需求工作流?