848373be4ecf00dda0660dc127de60aa0a88e6a7
[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>comentários</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>Dentro de uma função, as primeiras linhas de comentário até a
16             primeira instrução ou linha vazia podem ser usadas para fornecer o
17             conteúdo padrão para a documentação de ajuda da função ("help" da função).
18         </para>
19     </refsection>
20     <refsection>
21         <title>Exemplos</title>
22         <programlisting role="example"><![CDATA[ 
23 g=9.81// a gravidade
24
25 text='a//b'
26
27 function y=myfunction(x)
28 //  myfunction computa y=x^2+1
29 // x deve ser um vetor ou uma matriz
30   y=x^2+1
31 endfunction
32
33 help myfunction
34  ]]></programlisting>
35     </refsection>
36 </refentry>