Documentation
CodeMaker AI
  • Quick start
    • Overview
    • Getting Started
      • Visual Studio Code
      • JetBrains
      • GitHub Action
      • CodeMaker CLI
  • Features
    • Coding Assistant
    • Interactive
      • Autocompletion
      • Inline code generation
      • Code Actions
      • Syntax Autocorrection
    • Batch
      • Code generation
      • Documentation generation
      • Predictive code generation
    • Source Context
    • Source Graph
  • Models
    • Fine-Tunning
  • Knowledge Base
    • Indexes
  • Source Code
    • Repositories
  • Integrations
    • IDE
      • Visual Studio Code
      • JetBrains
    • GitHub
      • GitHub Action
        • Continous Integration
        • Pull Requests
      • GitHub App
    • CLI
    • SDK
      • Go
      • JavaScript
Powered by GitBook
On this page
  • Summary
  • IDE: Visual Studio Code and JetBrains
  • GitHub
  • General questions
  • Source Code
  • Source Code questions
  • Source Code Editing
  1. Features

Coding Assistant

PreviousCodeMaker CLINextInteractive

Last updated 1 year ago

The Assistant is currently available in preview. Its capabilities may be subject to change.

Summary

Coding Assistant offers a unified experience across all of the CodeMaker AI integrated environments. Currently available in preview for InteliJ, Visual Studio Code, and GitHub.

You can ask the assistant questions that it will answer best to its ability and with respect to the data that it has been trained on.

IDE: Visual Studio Code and JetBrains

Assistant can be used to answer questions related to the source code directly from the IDE. The assistant is contextual and supports answering questions related to the currently active code editor. This feature is supported for all CodeMaker AI supported programming languages.

GitHub

All of the Assistant features are also available through GitHub App. The Assistant can answer questions on GitHub Issues or GitHub Pull Request where it can also answer questions related to the associated code change. In this case, to remove ambiguity it is also needed to specify the name of the file to which the given prompt relates.

General questions

The Assistant can answer any general questions related to programming or specific technology. Its knowledge is up to date to the date of the dataset that the model has been trained.

Source Code

The Assistant is capable of answering questions directly related to the source code as well as performing changes to the file. This feature is available for all of the CodeMaker AI supported programming languages.

Source Code questions

The Assistant can answer questions related to the source code and integrate seamlessly with it. This experience is available in IDEs Visual Studio Code and InteliJ. If there is an active editor open that contains a source file it is possible to ask specific questions about the code. You can formulate the prompts freely, the only limitation is that the questions need to be related to named blocks of code like methods or functions.

Note that all of the below prompts are only examples used to showcase the available features. Prompts can be created quite freely.

Explaining a function

To ask the Assistant to explain a specific function you can simply write:

Explain [function name] function.

Explaining a method

To ask the Assistant to explain a specific method you can simply write:

Explain [method name] method.

Explain [method name] method of [class name] class.

Reviewing a function

To ask the Assistant to review a specific function you can simply write:

Review [function name] function.

Suggest improvements for [function name] function.

Reviewing a method

To ask the Assistant to review a specific method you can simply write:

Review [method name] method.

Review [method name] method of [class name] class.

Suggest improvements for [method name] method.

Suggest improvements for [method name] method of [class name] class.

Source Code Editing

The Assistant is capable of editing the source code directly in the active editor. In this case, it will make the changes directly in the source file.

Adding a function

To ask the Assistant to add a function to the current file write:

Add function [function name], that [description of the function behavior].

Adding a class

To ask the Assistant to add a class to the current file write:

Add class [class name], that [description of the class behavior].

Adding a method

To ask the Assistant to add a method to the current file write:

Add method [method name], that [description of the method behavior].

Editing a function

To ask the Assistant to edit a function in the current file write:

Edit function [function name]. [description of the change]

Editing a method

To ask the Assistant to edit a method in the current file write:

Edit method [method name]. [description of the change]

Edit method [method name] of [class name] class. [description of the change]

Deleting a function

To ask the Assistant to delete a function in the current file write:

Delete a function [function name].

Deleting a method

To ask the Assistant to delete a method in the current file write:

Delete a method [method name].

Delete a method [method name] of [class name] class.
Coding Assistant in IDE
Coding Assistant in GitHub