1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="plugin-code-comment">
<info>
<link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
<revision version="3.4" date="2013-02-24" status="review"/>
<revision pkgversion="3.34" date="2020-02-09" status="review"/>
<credit type="author">
<name>Jim Campbell</name>
<email its:translate="no">jwcampbell@gmail.com</email>
</credit>
<desc>Comment-out or uncomment a block of code.</desc>
</info>
<title>Code comment</title>
<p>Code comments are portions of text that make it easier for people to
understand a program's code, but they don't affect how a program works.
Comments are separated from other parts of a program by special
characters.</p>
<p>The <app>code comment</app> plugin makes it easier to quickly create or
remove code comments.</p>
<steps>
<title>To enable the plugin:</title>
<item>
<p>Press the menu button in the top-right corner of the window and select
<guiseq><gui style="menuitem">Preferences</gui>
<gui style="tab">Plugins</gui></guiseq>.</p>
</item>
<item>
<p>Select <gui style="menuitem">Code comment</gui> to enable the plugin.</p>
</item>
</steps>
<steps>
<title>To create or remove a comment:</title>
<item>
<p>Highlight the portion of text where you want to add or remove a
comment.</p>
</item>
<item>
<p>To add a comment, right click and select <gui style="menuitem">Comment
Code</gui>, or press <keyseq><key>Ctrl</key><key>M</key></keyseq>.</p>
</item>
<item>
<p>To remove a comment, right click and select
<gui style="menuitem">Uncomment Code</gui>, or press
<keyseq><key>Shift</key> <key>Ctrl</key><key>M</key></keyseq>.</p>
</item>
</steps>
<note style="tip">
<p><app>gedit</app> will automatically use the correct style of comment
based on the language or syntax of the file. If <app>gedit</app> doesn't
identify your language or syntax, you can select it from the language list
in the bottom <gui>Status bar</gui>.</p>
</note>
</page>
|
