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
|
<html lang="en">
<head>
<title>Comments and the Help System - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Comments.html#Comments" title="Comments">
<link rel="prev" href="Block-Comments.html#Block-Comments" title="Block Comments">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Comments-and-the-Help-System"></a>
Previous: <a rel="previous" accesskey="p" href="Block-Comments.html#Block-Comments">Block Comments</a>,
Up: <a rel="up" accesskey="u" href="Comments.html#Comments">Comments</a>
<hr>
</div>
<h4 class="subsection">2.7.3 Comments and the Help System</h4>
<p><a name="index-documenting-functions-168"></a><a name="index-documenting-user-scripts-169"></a><a name="index-help_002c-user_002ddefined-functions-170"></a>
The <code>help</code> command (see <a href="Getting-Help.html#Getting-Help">Getting Help</a>) is able to find the first
block of comments in a function and return those as a documentation
string. This means that the same commands used to get help
on built-in functions are available for properly formatted user-defined
functions. For example, after defining the function <code>f</code> below,
<pre class="example"> function xdot = f (x, t)
# usage: f (x, t)
#
# This function defines the right-hand
# side functions for a set of nonlinear
# differential equations.
r = 0.25;
...
endfunction
</pre>
<p>the command <kbd>help f</kbd> produces the output
<pre class="example"> usage: f (x, t)
This function defines the right-hand
side functions for a set of nonlinear
differential equations.
</pre>
<p>Although it is possible to put comment lines into keyboard-composed,
throw-away Octave programs, it usually isn't very useful because the
purpose of a comment is to help you or another person understand the
program at a later time.
<p>The <code>help</code> parser currently only recognizes single line comments
(see <a href="Single-Line-Comments.html#Single-Line-Comments">Single Line Comments</a>) and not block comments for the initial
help text.
<!-- DO NOT EDIT! Generated automatically by munge-texi. -->
<!-- Copyright (C) 1996, 1997, 2007, 2009 John W. Eaton -->
<!-- This file is part of Octave. -->
<!-- Octave is free software; you can redistribute it and/or modify it -->
<!-- under the terms of the GNU General Public License as published by the -->
<!-- Free Software Foundation; either version 3 of the License, or (at -->
<!-- your option) any later version. -->
<!-- Octave is distributed in the hope that it will be useful, but WITHOUT -->
<!-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -->
<!-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -->
<!-- for more details. -->
<!-- You should have received a copy of the GNU General Public License -->
<!-- along with Octave; see the file COPYING. If not, see -->
<!-- <http://www.gnu.org/licenses/>. -->
</body></html>
|
