Hello everyone! Ever wondered, “How can I generate documentation or javadoc effortlessly?” Especially when the code in front of you lacks any comments. 😂
Worry not! Let ChatGPT assist you. With the script I’ve prepared, you can transform ChatGPT into a professional ‘code interpreter’ for your projects, enabling super-convenient documentation and javadoc creation. This is also the framework that I have applied at Pitagon and PiSafe, PetApp.
Download ChatGPT Framework
To kick things off, click on the below link, view in `Raw` to download the optimized script for ChatGPT (and don’t forget to give yourself a star on GitHub :D).
https://gist.github.com/travistran1989/7cb0e39cb8f8914e3d655f6cd9e20370
Once you’ve got the script, just ‘throw’ it into ChatGPT and wait for a bit… And voilà! You’ve got yourself a code ‘interpreter’ ready to help.
Start framework
Invoke ChatGPT with the command:
[Start TravisJDM]
and you’ll be guided on how to “converse” with your code.
Using TravisJDM
Submit your Java code, use the format
[code] <mã lệnh>
and… tada! 🎉 ChatGPT will “understand” your code, elucidate everything, and produce high-quality javadoc or documentation.
Now, creating documentation for your projects will be faster and simpler than ever. In this article, I use Java as the main language. For other languages, I will add the necessary frameworks to meet the rules of each language. You can also contribute to this open source project at https://github.com/travistran1989/ai-prompt-framework/tree/main/chatgpt/code-doc-generator/.
Don’t forget to note that ChatGPT has limits too, so if you see it missing something, remind it to keep working. Happy coding and may you produce top-notch documentation!
If you have any questions, please contact me at the contactpage.
Hello everyone! Ever wondered, “How can I generate documentation or javadoc effortlessly?” Đặc biệt khi đống code trước mắt bạn không có một dòng comment nào. 😂Đừng lo! Let ChatGPT assist you. With the script I’ve prepared, you can transform ChatGPT into a professional ‘code interpreter’ for your projects, enabling super-convenient documentation and javadoc creation.
Để bắt đầu, hãy click vào link ở phần mô tả bài viết để tải về kịch bản tối ưu hóa cho ChatGPT. Once you’ve got the script, just ‘throw’ it into ChatGPT and wait for a bit… And voilà! You’ve got yourself a code ‘interpreter’ ready to help.
Gọi ChatGPT bằng câu lệnh: [Start TravisJDM] và bạn sẽ được hướng dẫn chi tiết cách “nói chuyện” với code. Đưa code Java của bạn vào, sử dụng cú pháp [code]
Now, creating documentation for your projects will be faster and simpler than ever. Và nhớ, dù bạn đang làm việc với Java hay bất kỳ ngôn ngữ lập trình nào khác, ChatGPT luôn sẵn lòng giúp đỡ.
Don’t forget to note that ChatGPT has limits too, so if you see it missing something, remind it to keep working. Happy coding and may you produce top-notch documentation!
một cách nhanh chóng?” chưa? Đặc biệt khi đống code trước mắt bạn không có một dòng comment nào. 😂Đừng lo! Let ChatGPT assist you. With the script I’ve prepared, you can transform ChatGPT into a professional ‘code interpreter’ for your projects, enabling super-convenient documentation and javadoc creation.
Để bắt đầu, hãy click vào link ở phần mô tả bài viết để tải về kịch bản tối ưu hóa cho ChatGPT. Once you’ve got the script, just ‘throw’ it into ChatGPT and wait for a bit… And voilà! You’ve got yourself a code ‘interpreter’ ready to help.
Gọi ChatGPT bằng câu lệnh: [Start TravisJDM] và bạn sẽ được hướng dẫn chi tiết cách “nói chuyện” với code. Đưa code Java của bạn vào, sử dụng cú pháp [code]
Now, creating documentation for your projects will be faster and simpler than ever. Và nhớ, dù bạn đang làm việc với Java hay bất kỳ ngôn ngữ lập trình nào khác, ChatGPT luôn sẵn lòng giúp đỡ.
Don’t forget to note that ChatGPT has limits too, so if you see it missing something, remind it to keep working. Happy coding and may you produce top-notch documentation!