Essential for Making Money! MarsCode Magic: Generate Open Source Project Documentation in Seconds, Make Your Codebase Famous Across the Internet!
👉 Project Website: https://www.python-office.com/ 👈
👉 Open Source Project Discussion Group 👈
Hello everyone, this is Programmer Wan Feng, currently all in on AI Programming Practice.
Like everyone else, every time I hear about writing documentation, I get a headache.
So I wondered, can I use a large model to write documentation?
Coincidentally, I'm currently iterating on the python-office open source project, and for one of its sub-projects: popdf, I wrote all the code comments and project documentation using a large model.
The large model I used is: MarsCode Programming Assistant.
Requirements
I developed a Python document processing open source project: python-office has been around for 5 years, but because of laziness, documentation has never been good.
However, this project is mainly for beginners, so documentation is very important.
So this time I plan to write documentation for each feature, so everyone can use it as needed.
Using Large Model to Implement
1. Install Plugin
First, install the MarsCode Programming Assistant plugin in VSCode.
2. Generate Documentation Template
Then, enter the following command in the plugin:
Based on the python-office code repository: https://github.com/CoderWanFeng/python-office, write documentation for the popdf module of the python-office project for me.
3. Edit Documentation
Next is copy and paste, then modify the details.
But in the process of modification, MarsCode will provide documentation completion features, which greatly improves my work efficiency.
4. Result Display
Finally, I finished generating all the documentation for this project, and the effect is very good.
As you can see, using MarsCode to write documentation is much faster than writing it myself.
I also put this project's documentation on Gitee, everyone can download and use it directly.
Final Words
Technical people pay more attention to the details of technical implementation, but writing documentation is also a very important task for a project.
For some repetitive descriptions, they can completely be handed over to large models to implement.
🎓 AI 编程实战课程
想系统学习 AI 编程？程序员晚枫的 AI 编程实战课 帮你从零上手！
- 👉 课程报名：点击这里报名，前3讲免费试听
- 👉 免费试看：B站免费试看前3讲，先看看适不适合自己
微信进群
