Effortlessly Write Perfect Documentation and Git Commit Messages with AI assistance on VSCode
Two free Vscode extensions every developer should add to their arsenal. I must thank the user Ishpreet for asking whether I had come across documentation tool that works across shared projects on each file.
Mintlify supports C, C++, Python, TypeScript, JavaScript, PHP, C#, Rust, Go and many more. It supports various docstrings formats which are essentially ways to document your code and explain what it does, namely JSDoc, reST, NumPy, Google, XML etc. It utilizes OpenAI's GPT-4 for quickly generating documentation. Unlike other extensions, you won't have to provide your own OpenAI API key. Plus, you'll receive a fully functional extension right away. You can write documentation in various languages such as English, Japanese, French, Chinese etc. The good thing is that our code is never sent or used and resides in our machine. You can read their privacy policy in the description. If you click on Mintlify icon in the sidebar you will see different sections namely Generate Docs, Docstring format, Track Documentation Progress, Set Writing Language, Invite Team members and Key bindings.
CommitAI generates Commit Message for starters and has loads of features such as Write Test cases for specific methods or entire file, Analyse Folder Structure, Explain Code, Analyse Time Complexity of your code and Suggest names for methods out of the box.
Links:
Mintlify Doc Writer: https://marketplace.visualstudio.com/...
Mintlify Privacy Policy: https://www.mintlify.com/security
CommitAI(Removed or Deprecated): https://marketplace.visualstudio.com/...
Git History: https://marketplace.visualstudio.com/...
GitLens: https://marketplace.visualstudio.com/...
GitHub Repo: https://github.com/vasudev-gm/django_...
Thumbnail created by Freepik: https://www.freepik.com/free-photo/pe...
Timestamps:
00:00 Start
00:27 intro to Mintlify and CommitAI
02:51 CommitAI
03:36 Analyse folder structure
04:03 Explain code
04:28 Time complexity
05:18 Generate method names
05:46 Write unit test cases
06:12 Generate Commit Messages