Skip to content

A Jetbrains plugin to generate technical and general documentation for functional codebases, using AI. Supports Dart for technical docs, and 20+ languages for general documentation.

License

Notifications You must be signed in to change notification settings

cyenite/codescribe

Repository files navigation

Jetbrains Plugin

Codescribe

Build

A documentation plugin that uses the power of artificial intelligence to make coding swifter and save on time.

To use Codescribe, you must have an OpenAI access token. With this token, you can access a variety of features, including code comments and function documentation.

Code Actions

The following actions are available for coding in the AI Coder plugin:

Text Description
Add Code Comments The Add Code Comments action allows you to quickly add comments to selected code. It will generally add a comment for each line with a description. This is useful for quickly documenting your code and making it easier to understand.
Document Function The Document Function action allows you to quickly add a technical documentation to your code that describes the current function selection. This is useful for quickly documenting your code and making it easier to understand.

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "Codescribe" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Usage

After installation, edit the settings and add your API key. If desired, customize your style!

Use the context menu to access features by selecting the code you want to describe and right-clicking. You can also use the keyboard shortcut Ctrl+Shift+A to access the action menu.


Plugin based on the IntelliJ Platform Plugin Template.

About

A Jetbrains plugin to generate technical and general documentation for functional codebases, using AI. Supports Dart for technical docs, and 20+ languages for general documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages