intellij-sdk-code-samples/tutorials/custom_language_support/commenter.md

layout	title
editable	17. Commenter

A commenter allows user to comment the code at the cursor or selected code automatically via ⌘/.

1. Define a commenter

package com.simpleplugin;

import com.intellij.lang.Commenter;
import org.jetbrains.annotations.Nullable;

public class SimpleCommenter implements Commenter {
    @Nullable
    @Override
    public String getLineCommentPrefix() {
        return "#";
    }

    @Nullable
    @Override
    public String getBlockCommentPrefix() {
        return "";
    }

    @Nullable
    @Override
    public String getBlockCommentSuffix() {
        return null;
    }

    @Nullable
    @Override
    public String getCommentedBlockCommentPrefix() {
        return null;
    }

    @Nullable
    @Override
    public String getCommentedBlockCommentSuffix() {
        return null;
    }
}

2. Register the commenter

<lang.commenter language="Simple" implementationClass="com.simpleplugin.SimpleCommenter"/>

3. Run the project

Previous Top Next