mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 17:27:49 +08:00
1.4 KiB
1.4 KiB
title |
---|
17. Commenter |
A commenter enables the user to comment out line of code at the cursor or selected code automatically.
The Commenter
defines support for "Comment with Line Comment" and "Comment with Block Comment" actions.
- bullet list {:toc}
17.1. Define a Commenter
The Simple language commenter subclasses Commenter
.
This commenter defines the line comment prefix as "#".
{% include /code_samples/simple_language/src/main/java/com/intellij/sdk/language/SimpleCommenter.java %}
17.2. Register the Commenter
The SimpleCommenter
implementation is registered with the IntelliJ Platform in plugin.xml
using the lang.commenter
extension point.
<extensions defaultExtensionNs="com.intellij">
<lang.commenter language="Simple" implementationClass="com.intellij.sdk.language.SimpleCommenter"/>
</extensions>
17.3. Run the Project
Open the example Simple Language properties file in the IDE Development Instance.
Place the cursor at the website
line.
Select Code | Comment with Line Comment.
The line is converted to a comment.
Select Code | Comment with Line Comment again, and the comment is converted back to active code.