* Bug #14105 fixed - New block comments /*...*/ feature was not documented.
[scilab.git] / scilab / modules / core / help / en_US / 1_keywords / comments.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="comments">
3     <refnamediv>
4         <refname>comments</refname>
5         <refpurpose>(// or /*...*/) comments</refpurpose>
6     </refnamediv>
7     <refsection>
8         <title>Description</title>
9         <para>
10             A sequence of two consecutive slashes <literal>//</literal> out of
11             a string definition marks the beginning of a comment. The slashes
12             as well as all the following characters up to the end of the lines
13             are not interpreted.
14         </para>
15         <para>
16             Another way to comment a block of code is to use /* at the beginning
17             and */ at the end. It is more useful than // which must be positioned at the
18             beginning of each line to comment.
19         </para>
20         <para>Inside a function, the first comment lines, up to the first
21             instruction or an empty line may be used to provide the default
22             contents for the function help.
23         </para>
24     </refsection>
25     <refsection>
26         <title>Examples</title>
27         <programlisting role="example"><![CDATA[ 
28 g=9.81// the gravity
29
30 text='a//b'
31
32 /* As this comment is quite long to be on many lines,
33 the symbols slash and star to start the comment
34 and star and slash to end the comment are used */
35
36 function y=myfunction(x)
37   // myfunction computes y=x^2+1
38   // x should be a vector or matrix
39   y=x^2+1
40 endfunction
41
42 help myfunction
43  ]]></programlisting>
44     </refsection>
45     <refsection role="see also">
46         <title>See Also</title>
47         <simplelist type="inline">
48             <member>
49                 <link linkend="slash">slash</link>
50             </member>
51             <member>
52                 <link linkend="backslash">backslash</link>
53             </member>
54         </simplelist>
55     </refsection>
56 </refentry>