AI automatically generates annotation documents from code

Two things programmers hate most ：

1. Write your own notes
2. 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