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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Comment Tips</title>
<meta name="description" content="GNU Octave: Comment Tips">
<meta name="keywords" content="GNU Octave: Comment Tips">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Tips-and-Standards.html#Tips-and-Standards" rel="up" title="Tips and Standards">
<link href="Function-Headers.html#Function-Headers" rel="next" title="Function Headers">
<link href="Style-Tips.html#Style-Tips" rel="prev" title="Style Tips">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Comment-Tips"></a>
<div class="header">
<p>
Next: <a href="Function-Headers.html#Function-Headers" accesskey="n" rel="next">Function Headers</a>, Previous: <a href="Style-Tips.html#Style-Tips" accesskey="p" rel="prev">Style Tips</a>, Up: <a href="Tips-and-Standards.html#Tips-and-Standards" accesskey="u" rel="up">Tips and Standards</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Tips-on-Writing-Comments"></a>
<h3 class="section">C.2 Tips on Writing Comments</h3>
<p>Here are the conventions to follow when writing comments.
</p>
<dl compact="compact">
<dt>‘<samp>#</samp>’</dt>
<dd><p>Comments that start with a single sharp-sign, ‘<samp>#</samp>’, should all be
aligned to the same column on the right of the source code. Such
comments usually explain how the code on the same line does its job. In
the Emacs mode for Octave, the <kbd>M-;</kbd> (<code>indent-for-comment</code>)
command automatically inserts such a ‘<samp>#</samp>’ in the right place, or
aligns such a comment if it is already present.
</p>
</dd>
<dt>‘<samp>##</samp>’</dt>
<dd><p>Comments that start with a double sharp-sign, ‘<samp>##</samp>’, should be aligned to
the same level of indentation as the code. Such comments usually
describe the purpose of the following lines or the state of the program
at that point.
</p></dd>
</dl>
<p>The indentation commands of the Octave mode in Emacs, such as <kbd>M-;</kbd>
(<code>indent-for-comment</code>) and <kbd>TAB</kbd> (<code>octave-indent-line</code>)
automatically indent comments according to these conventions,
depending on the number of semicolons. See <a href="http://www.gnu.org/software/emacs/manual/html_node/emacs/Comments.html#Comments">Manipulating Comments</a> in <cite>The GNU Emacs Manual</cite>.
</p>
</body>
</html>
|
