当前位置:网站首页>AI 从代码中自动生成注释文档
AI 从代码中自动生成注释文档
2022-07-06 17:36:00 【小盒子的技术分享】
程序员最讨厌的两件事:
自己写注释 别人不写注释
Mintlify 的插件终于可以把我们从痛苦的死循环中解救出来了。
Mintlify 利用 AI 技术从代码中自动生成注释文档
注意 it's free
但谁知道呢,也许过一阵子就像 github 的 Copilot
一样开始收费了也说不定。
来个Demo
比如我这段简单的二分查找
程序片段:
分别看下 Mintlify
为它生成的注释,注意:它可以生成多语言的,有英文的也有中文的
上面这些都是自动生成的,从结果看是基于程序进行的翻译,比较罗嗦,但还算准确。
应用
好啦,那剩下的事情就是把你写完的程序一键生成注释,然后一份带有良好(啰嗦)注释的代码就编写完成了,如果你的团队统计代码和注释行数(哪个团队这么SB,告诉我,避个坑),那么又愉快地完成了KPI
。
开个玩笑 ,良好的代码注释,不但有利于别人阅读,更有利于维护,有时候时间长了,我们自己都不知道写的是什么玩意,我有时候看到一大段程序没有注释还写的特别绕的时候就开始骂娘了:“这TM写的什么玩意儿”,讽刺的是,有些时候,那程序是我自己写的。哈哈。
都说优秀的代码可以做到自解释
,不用写注释也看得懂,对,那是优秀的代码,在你还不能写成那样的代码之前,写注释吧孩子,先保证你不会被团队的同学骂娘再说。
提示
如安装插件或使用过程中遇到网络问题,请通过科学上网自行解决。如这玩意(https://www.mintlify.com/)开始收费了,当我没说。
本文由 mdnice 多平台发布
边栏推荐
- Part V: STM32 system timer and general timer programming
- Taro2.* 小程序配置分享微信朋友圈
- Openjudge noi 1.7 10: simple password
- Return to blowing marshland -- travel notes of zhailidong, founder of duanzhitang
- C # method of calculating lunar calendar date 2022
- Force buckle 1037 Effective boomerang
- 「笔记」折半搜索(Meet in the Middle)
- Neon Optimization: an optimization case of log10 function
- [100 cases of JVM tuning practice] 04 - Method area tuning practice (Part 1)
- Provincial and urban level three coordinate boundary data CSV to JSON
猜你喜欢
Part V: STM32 system timer and general timer programming
[Niuke] [noip2015] jumping stone
Can the system hibernation file be deleted? How to delete the system hibernation file
[100 cases of JVM tuning practice] 04 - Method area tuning practice (Part 1)
身体质量指数程序,入门写死的小程序项目
让我们,从头到尾,通透网络I/O模型
Tensorflow GPU installation
Provincial and urban level three coordinate boundary data CSV to JSON
"Exquisite store manager" youth entrepreneurship incubation camp - the first phase of Shunde market has been successfully completed!
Dell筆記本周期性閃屏故障
随机推荐
BFS realizes breadth first traversal of adjacency matrix (with examples)
微信公众号发送模板消息
Informatics Orsay Ibn YBT 1172: find the factorial of n within 10000 | 1.6 14: find the factorial of n within 10000
Your cache folder contains root-owned files, due to a bug in npm ERR! previous versions of npm which
THREE.AxesHelper is not a constructor
[case sharing] basic function configuration of network loop detection
Boot - Prometheus push gateway use
云呐-工单管理制度及流程,工单管理规范
Wood extraction in Halcon
Make a simple graphical interface with Tkinter
Mongodb client operation (mongorepository)
How to evaluate load balancing performance parameters?
Can the system hibernation file be deleted? How to delete the system hibernation file
C# 计算农历日期方法 2022
【JVM调优实战100例】04——方法区调优实战(上)
ESP Arduino (IV) PWM waveform control output
深度学习框架TF安装
Neon Optimization: an optimization case of log10 function
How to manage distributed teams?
界面控件DevExpress WinForms皮肤编辑器的这个补丁,你了解了吗?