You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
1.9 KiB
37 lines
1.9 KiB
<chapter id="documentation">
|
|
<title>Documentação</title>
|
|
|
|
<para>A documentação, infelizmente, pertence às questões mais subestimadas da programação. Contudo, uma vez configurada devidamente e mantida a nível interno e externo, a documentação oferece uma ajuda muito valiosa. </para>
|
|
|
|
<para>A documentação tem várias facetas. Existe a <itemizedlist>
|
|
<listitem><para><emphasis>documentação interna do projecto</emphasis>, que consiste principalmente em <itemizedlist>
|
|
<listitem><para><emphasis>comentários</emphasis> nos ficheiros de código/inclusão </para></listitem>
|
|
<listitem><para><emphasis>documentação interna da &API;</emphasis> do seu projecto, gerada a partir dos ficheiros do programa com ferramentas especiais, ⪚ &doxygen; </para></listitem>
|
|
</itemizedlist>
|
|
</para></listitem>
|
|
<listitem><para><emphasis>documentação externa do projecto</emphasis>, que inclui, entre outras <itemizedlist>
|
|
<listitem><para><emphasis>a documentação externa da &API;</emphasis> de ⪚ bibliotecas do sistema comuns (&kde;, &Qt;, &etc;) </para></listitem>
|
|
<listitem><para>qualquer outra documentação (manuais da linguagem de programação, informação de sistema geral, artigos e tutoriais, entre outros) </para></listitem>
|
|
</itemizedlist>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>Toda esta documentação deverá ser fácil de manter e prontamente disponível sempre que necessitar dela. O &tdevelop; tem todas as capacidades para tal. </para>
|
|
|
|
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
|
|
|
|
<sect1 id="docbrowser">
|
|
<title>O Navegador de Documentação</title>
|
|
|
|
|
|
<figure id="screenshot-doctreeview" float="1">
|
|
<title>Uma Imagem da Árvore de Documentação</title>
|
|
<mediaobject>
|
|
<imageobject><imagedata fileref="doctreeview.png"/></imageobject>
|
|
</mediaobject>
|
|
</figure>
|
|
|
|
</sect1> <!-- docbrowser -->
|
|
|
|
</chapter> <!-- documentation -->
|