|
|
<chapter id="documentation">
|
|
|
<title>Документирование</title>
|
|
|
|
|
|
<para>К несчастью, написание документации часто бывает сложнее написания кода. Но продуманно организованная и понятно написанная, она оказывает значительную помощь в разработке, позволяющую не обращаться лишний раз за советом на форумы, или, что ещё лучше, к автору. </para>
|
|
|
|
|
|
<para>Документирование имеет несколько граней. Это <itemizedlist>
|
|
|
<listitem><para><emphasis>внутренняя документация проекта</emphasis>, состоящая в основном из <itemizedlist>
|
|
|
<listitem><para><emphasis>комментариев</emphasis> в исходных файлах </para></listitem>
|
|
|
<listitem><para><emphasis>внутренняя &API;-документация</emphasis>, генерируемая специальными инструментами, такими как &doxygen; </para></listitem>
|
|
|
</itemizedlist>
|
|
|
</para></listitem>
|
|
|
<listitem><para><emphasis>внешняя документация проекта</emphasis> <itemizedlist>
|
|
|
<listitem><para><emphasis>внешняя &API;-документация</emphasis>, например по функциям библиотек (&kde;, &Qt; и т.д.) </para></listitem>
|
|
|
<listitem><para>другая документация (по языкам программирования, статьи HOWTO, общая системная информация) </para></listitem>
|
|
|
</itemizedlist>
|
|
|
</para></listitem>
|
|
|
</itemizedlist>
|
|
|
</para>
|
|
|
<para>Вся указанная документация должна быть удобна и легко доступна, когда она понадобится. &tdevelop; предлагает гибкое решение для этого. </para>
|
|
|
|
|
|
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
|
|
|
|
|
|
<sect1 id="docbrowser">
|
|
|
<title>Обзор документации</title>
|
|
|
|
|
|
|
|
|
<figure id="screenshot-doctreeview" float="1">
|
|
|
<title>Снимок экрана структуры документации</title>
|
|
|
<mediaobject>
|
|
|
<imageobject><imagedata fileref="doctreeview.png"/></imageobject>
|
|
|
</mediaobject>
|
|
|
</figure>
|
|
|
|
|
|
</sect1> <!-- docbrowser -->
|
|
|
|
|
|
</chapter> <!-- documentation -->
|
