当前位置:网站首页>AI automatically generates annotation documents from code
AI automatically generates annotation documents from code
2022-07-05 20:33:00 【Small box】
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 .
边栏推荐
猜你喜欢
[quick start of Digital IC Verification] 6. Quick start of questasim (taking the design and verification of full adder as an example)
走入并行的世界
关于BRAM IP复位的优先级
Leetcode (695) - the largest area of an island
无卷积骨干网络:金字塔Transformer,提升目标检测/分割等任务精度(附源代码)...
- Oui. Net Distributed Transaction and Landing Solution
信息学奥赛一本通 1339:【例3-4】求后序遍历 | 洛谷 P1827 [USACO3.4] 美国血统 American Heritage
[quick start of Digital IC Verification] 7. Basic knowledge of digital circuits necessary for verification positions (including common interview questions)
2.8 basic knowledge of project management process
[record of question brushing] 1 Sum of two numbers
随机推荐
CCPC 2021 Weihai - G. shinyruo and KFC (combination number, tips)
14、Transformer--VIT TNT BETR
Common view container class components
基金网上开户安全吗?去哪里开,可以拿到低佣金?
Frequent MySQL operations cause table locking problems
Dry goods navigation in this quarter | Q2 2022
Leetcode (347) - top k high frequency elements
Applet project structure
Enter the parallel world
ROS2专题【01】:win10上安装ROS2
小程序页面导航
2020 CCPC Weihai - A. golden spirit (thinking), D. ABC project (big number decomposition / thinking)
How to form standard interface documents
IC科普文:ECO的那些事儿
Applet event binding
USACO3.4 “破锣摇滚”乐队 Raucous Rockers - DP
信息学奥赛一本通 1338:【例3-3】医院设置 | 洛谷 P1364 医院设置
Leetcode brush question: binary tree 13 (the same tree)
[quick start of Digital IC Verification] 7. Basic knowledge of digital circuits necessary for verification positions (including common interview questions)
欢迎来战,赢取丰厚奖金:Code Golf 代码高尔夫挑战赛正式启动