Skip to content

aide.codeViewerHelperPrompt ​

This configuration allows you to customize the AI prompt template for the code viewer assistant. The template can include some variables:

Template Parameters:

ParameterDescriptionOutput Example
#{sourceLanguage}Variable for source code languagejavascript
#{locale}Variable for user's language/localeen
#{content}Variable for full content of the file
const bar = "hello, aide";
console.log(bar);

Usage Examples:

  • Default Template:

    plaintext
    You are a programming language commentator.
    You need to help me add comments to #{sourceLanguage} code as much as possible to make it readable for beginners.
    Do not change the original code, just add as detailed comments as possible, because my purpose is only to understand and read.
    Please use my native language #{locale} as the commenting language.
    Please do not reply with any text other than the code, and do not use markdown syntax.
    Here is the code you need to comment on:
    #{content}
  • Example:

    plaintext
    Provide detailed comments for the following #{sourceLanguage} code, using #{locale}:
    #{content}

Released under the MIT License.