* Bug #14105 fixed - New block comments /*...*/ feature was not documented.
[scilab.git] / scilab / modules / core / help / pt_BR / 1_keywords / comments.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="comments" xml:lang="en">
3     <refnamediv>
4         <refname>comments</refname>
5         <refpurpose>(// or /*...*/) comments</refpurpose>
6     </refnamediv>
7     <refsection>
8         <title>Descrição</title>
9         <para>
10             Uma seqüência de duas barras <literal> // </literal> fora de uma
11             definição de string marca o início de um comentário. As barras, tanto
12             quanto o restante dos caracteres até o fim das linhas não são
13             interpretados. 
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>Dentro de uma função, as primeiras linhas de comentário até a
21             primeira instrução ou linha vazia podem ser usadas para fornecer o
22             conteúdo padrão para a documentação de ajuda da função ("help" da função).
23         </para>
24     </refsection>
25     <refsection>
26         <title>Exemplos</title>
27         <programlisting role="example"><![CDATA[ 
28 g=9.81// a gravidade
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 computa y=x^2+1
38 // x deve ser um vetor ou uma matriz
39   y=x^2+1
40 endfunction
41
42 help myfunction
43  ]]></programlisting>
44     </refsection>
45 </refentry>