|
Packit |
6978fb |
|
|
Packit |
6978fb |
xmlns:its="http://www.w3.org/2005/11/its"
|
|
Packit |
6978fb |
type="topic" style="task"
|
|
Packit |
6978fb |
id="plugin-code-comment">
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<info>
|
|
Packit |
6978fb |
<link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
|
|
Packit |
6978fb |
<revision version="3.4" date="2013-02-24" status="review"/>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<credit type="author">
|
|
Packit |
6978fb |
<name>Jim Campbell</name>
|
|
Packit |
6978fb |
<email its:translate="no">jwcampbell@gmail.com</email>
|
|
Packit |
6978fb |
</credit>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<desc>Comment-out or uncomment a block of code.</desc>
|
|
Packit |
6978fb |
</info>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<title>Code comment</title>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
Code comments are portions of text that make it easier for people to
|
|
Packit |
6978fb |
understand a program's code, but they don't affect how a program works.
|
|
Packit |
6978fb |
Comments are separated from other parts of a program by special
|
|
Packit |
6978fb |
characters.
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
The <app>code comment</app> plugin makes it easier to quickly create or
|
|
Packit |
6978fb |
remove code comments. To enable the code comment plugin, select
|
|
Packit |
6978fb |
<guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
|
|
Packit |
6978fb |
<gui>Plugins</gui><gui>Code comment</gui></guiseq>.
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<steps>
|
|
Packit |
6978fb |
<title>To create or remove a comment:</title>
|
|
Packit |
6978fb |
<item>
|
|
Packit |
6978fb |
Highlight the portion of text where you want to add or remove a
|
|
Packit |
6978fb |
comment.
|
|
Packit |
6978fb |
</item>
|
|
Packit |
6978fb |
<item>
|
|
Packit |
6978fb |
To add a comment, click <guiseq><gui style="menu">gedit</gui>
|
|
Packit |
6978fb |
<gui>Comment Code</gui></guiseq>, or press <keyseq><key>Ctrl</key>
|
|
Packit |
6978fb |
<key>M</key></keyseq>.
|
|
Packit |
6978fb |
</item>
|
|
Packit |
6978fb |
<item>
|
|
Packit |
6978fb |
To remove a comment, click <guiseq><gui style="menu">gedit</gui>
|
|
Packit |
6978fb |
<gui>Uncomment Code</gui></guiseq>, or press <keyseq><key>Shift</key>
|
|
Packit |
6978fb |
<key>Ctrl</key><key>M</key></keyseq>.
|
|
Packit |
6978fb |
</item>
|
|
Packit |
6978fb |
</steps>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
<note style="tip">
|
|
Packit |
6978fb |
<app>gedit</app> will automatically use the correct style of comment
|
|
Packit |
6978fb |
based on the language or syntax of the file. If <app>gedit</app> doesn't
|
|
Packit |
6978fb |
identify your language or syntax, you can select it from the language list
|
|
Packit |
6978fb |
in the bottom <gui>Status bar</gui>.
|
|
Packit |
6978fb |
</note>
|
|
Packit |
6978fb |
|
|
Packit |
6978fb |
</page>
|