Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.71 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.71 KB
Raw

Go AI Comment

GO AI Comment is an IntelliJ IDEA plugin that helps generate documentation comments for your code using AI. It can automatically generate a doc comment for the current function you're working on, or generate a summarized comment for a selected block of code.

Getting Started

To use Go AI Comment, you'll need to install it as a plugin in your IntelliJ editor (Goland). Here are the steps:

  1. Go to Settings -> Plugins -> Marketplace in your IntelliJ editor.
  2. Search for "Go AI Comment" and click on the Install button.
  3. Once the plugin is installed, restart IntelliJ IDEA editor to activate it.
  4. Retrieve your ChatGPT API key from OpenAI.
  5. Set the API Key in Settings -> Tools -> AI Comment

Using Go AI Comment

AI Comment provides two main features:

✅ Generate doc comment for Current function.
✅ Generate summarized comment for selected block of code.

To generate an AI comment, simply place your cursor inside a function or select a block for which you want to generate a comment, or select a block of code, then Go to Code -> Generate or Press Ctrl + N (or Cmd + N on a Mac) and select Generate Ai Comment from the menu.
The plugin will then use AI to generate a comment for your function or your block of code.

Contributing

If you'd like to contribute to Go AI Comment, please feel free to submit a pull request. We welcome contributions of all types, from bug fixes to new features.

License

Go AI Comment is licensed under the MIT License. See the LICENSE file for more information.

Contact

If you have any questions or feedback about Go AI Comment, please feel free to contact us at y.alhyane@gmail.com