当前位置:网站首页>AI automatically generates annotation documents from code
AI automatically generates annotation documents from code
2022-07-07 01:21:00 【Small box technology sharing】
Two things programmers hate most :
Write your own notes Others don't write notes
Mintlify Our plug-in can finally save us from the painful dead cycle .
Mintlify utilize AI Technology automatically generates annotation documents from code
Be careful it's free
But who knows , Maybe after a while, it's like github Of Copilot
It's also possible to start charging .
To a Demo
For example, my simple paragraph Two points search
Program fragment :
Let's have a look at Mintlify
Comments generated for it , Be careful : It can generate multilingual , There are English and Chinese
All the above are generated automatically , From the result, it is a program-based translation , Quite wordy , But it's still accurate .
application
All right. , The remaining thing is to generate comments on your finished program with one click , Then one with good ( repetitive ) The annotated code is written , If your team counts the number of lines of code and comments ( Which team is so SB, Tell me , Avoid a pit ), Then I finished happily KPI
.
To make fun of , Good code comments , It is not only beneficial for others to read , It's better to maintain , Sometimes it takes a long time , We don't even know what it is , Sometimes I start scolding when I see a large piece of program written around without comments :“ this TM What kind of writing ”, Ironically , Sometimes , I wrote the program myself . ha-ha .
It is said that excellent code can do Self explanation
, You can understand it without writing notes , Yes , That's excellent code , Before you can write code like that , Write notes, son , First make sure you won't be scolded by your classmates in the team .
Tips
If you encounter network problems during plug-in installation or use , Please solve it by yourself through scientific Internet . Such as this thing (https://www.mintlify.com/) It's starting to charge , When I didn't say .
This paper is written by mdnice Multi platform Publishing
边栏推荐
猜你喜欢
golang中的Mutex原理解析
[HFCTF2020]BabyUpload session解析引擎
[Niuke] b-complete square
Dark horse notes - exception handling
The MySQL database in Alibaba cloud was attacked, and finally the data was found
Asset security issues or constraints on the development of the encryption industry, risk control + compliance has become the key to breaking the platform
【C语言进阶篇】指针的8道笔试题
2022 Google CTF SEGFAULT LABYRINTH wp
Windows installation mysql8 (5 minutes)
Dynamic planning idea "from getting started to giving up"
随机推荐
Asset security issues or constraints on the development of the encryption industry, risk control + compliance has become the key to breaking the platform
Oracle: Practice of CDB restricting PDB resources
ESP Arduino (IV) PWM waveform control output
Niuke cold training camp 6B (Freund has no green name level)
What are the differences between Oracle Linux and CentOS?
身体质量指数程序,入门写死的小程序项目
736. Lisp 语法解析 : DFS 模拟题
Sword finger offer II 035 Minimum time difference - quick sort plus data conversion
from . cv2 import * ImportError: libGL. so. 1: cannot open shared object file: No such file or direc
Docker method to install MySQL
让我们,从头到尾,通透网络I/O模型
2022 Google CTF SEGFAULT LABYRINTH wp
AI 从代码中自动生成注释文档
golang中的Mutex原理解析
THREE.AxesHelper is not a constructor
动态规划思想《从入门到放弃》
taro3.*中使用 dva 入门级别的哦
Installation of torch and torch vision in pytorch
JTAG principle of arm bare board debugging
Make a simple graphical interface with Tkinter