...

пятница, 6 марта 2015 г.

Документируем код эффективно при помощи Doxygen


Данная статья представляет собой введение в систему документирования исходных текстов Doxygen, которая на сегодняшний день, по имеющему основания заявлению разработчиков, стала фактически стандартом для документирования программного обеспечения, написанного на языке C++, а также получила пусть и менее широкое распространение и среди ряда других языков.


В этой статье мы сначала познакомимся с самой системой и её возможностями, затем разберёмся с её установкой и базовыми принципами работы, и, наконец, завершим знакомство рассмотрением различных примеров документации, примеров того, как следует документировать те или иные части кода. Словом, познакомимся со всем тем, что позволит вам освоится и начать работать с этой замечательной системой.



Введение




Вероятнее всего, каждый из нас сталкивался с результатами работы различных генераторов документации. Общий принцип их работы следующий: на вход такого генератора поступает специальным образом комментированный исходный код, а иногда и другие компоненты программы, а на выходе создаётся готовая документация для распространения и использования.

Рассматриваемая система Doxygen как раз и выполняет эту задачу: она позволяет генерировать на основе исходного кода, содержащего комментарии специального вида, красивую и удобную документацию, содержащую в себе ссылки, диаграммы классов, вызовов и т.п. в различных форматах: HTML, LaTeX, CHM, RTF, PostScript, PDF, man-страницы.


Для того, чтобы составить общее впечатление о системе, ниже представлены примеры различных документаций для API, созданных при помощи Doxygen (следует обратить внимание, что в последние примеры внесены заметные изменения в сравнении со стандартной документацией, которую генерирует данная система):



  1. Документация к API игрового движка CrystalSpace

  2. Документация к Visualization Toolkit

  3. Документация к исходникам Abiword

  4. Документация к API KDE

  5. Документация к API Drupal




Внимательный читатель наверняка обратил внимание на то, что в большинстве примеров Doxygen используется для документации программного обеспечения, написанного на языке C++, однако на самом деле данная система поддерживает гораздо большое число других языков: C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, Tcl, и частично D.

Впрочем, следуя сложившейся традиции, в примерах я буду использовать C++, однако это не должно смущать вас, если вы предпочитаете другой поддерживаемый язык, поскольку особой разницы на практике вы даже не заметите, и большинство сказанного далее будет справедливо и для вашего языка.


К слову, список проектов, использующих Doxygen имеется на официальном сайте, причём большинство из этих проектов свободные. Поэтому желающие могут скачать исходник того или иного проекта и посмотреть как там разработчики осуществляли документацию.


Установка и настройка




Скачать последнюю версию Doxygen можно на официальном сайте, дистрибутивы которой доступны для большинства популярных операционных систем, кроме того, вы можете воспользоваться вашим пакетным менеджером. Помимо этого для комфортной и полнофункциональной работы рекомендуется установить Graphviz.

Далее работа с Doxygen весьма тривиальна: достаточно запустить программу, указав ей путь к файлу с настройками.



doxygen <config_file>




Но в этом файле и вся тонкость. Дело в том, что каждому проекту соответствует свой файл настроек, в котором может быть прописан путь до исходников проекта, путь, по которому должна быть создана документация, а также большое число других разнообразных опций, которые подробно описаны в документации, и которые позволяют максимально настроить документацию проекта проекта под свои нужды.

В принципе, для редактирования данного файла и, вообще, работой с Doxygen, можно воспользоваться программой Doxywizard, которая чаще всего идёт вместе с Doxygen и которая позволяет чуть удобнее работать с файлом настроек (слева – Doxywizard; справа – файл открытый в текстовом редакторе):


Итак, приступим к созданию файла с настройками. Вообще, если вы используете Doxywizard, то он будет создан автоматически, в противном случае для создания этого файла необходимо запустить программу Doxygen с ключом -g (от generate):



doxygen -g <config_name>




Рассмотрим основные опции, которые могут вам пригодится, чтобы создать первую вашу документацию:















































Тэг Назначение По умолчанию
DOXYFILE_ENCODINGКодировка, которая используется для всех символов в данном файле настроекUTF-8
OUTPUT_LANGUAGEУстанавливает язык, на котором будет сгенерирована документацияEnglish
PROJECT_NAMEНазвание проекта, которое может представлять собой единое слово или последовательность слов (если вы редактируете вне Doxygen, последовательность слов необходимо поместить в двойные кавычки)My Project
PROJECT_NUMBERДанный тэг может быть использован для указания номера проекта или его версии—
PROJECT_BRIEFКраткое однострочное описание проекта, которое размещается сверху каждой страницы и даёт общее представление о назначении проекта—
OUTPUT_DIRECTORYАбсолютный или относительный путь, по которому будет сгенерирована документацияТекущая директория
INPUTСписок файлов и/или директорий, разделенных пробелом, которые содержат в себе исходные коды проектаТекущая директория
RECURSIVEИспользуется в том случае, если необходимо сканировать исходные коды в подпапках указанных директорийNO

После того, как мы внесли необходимые изменения в файл с настройками (например, изменили язык, названия проекта и т.п.) необходимо сгенерировать документацию.

Для её генерации можно воспользоваться Doxywizard (для этого необходимо указать рабочую директорию, из которой будут браться исходные коды, перейти на вкладку «Run» и нажать «Run doxygen») или запустив программу Doxygen, указав ей в качестве параметра путь к файлу с настройками:



doxygen <config_file>


Основы документирования на Doxygen




Теперь, когда мы разобрались с тем, как настраивать Doxygen и работать с ним, впору разобраться с тем, как необходимо документировать код, основными принципами и подходами.

Документация кода в Doxygen осуществляется при помощи документирующего блока. При этом существует два подхода к его размещению:



  1. Он может быть размещён перед или после объявления или определения класса, члена класса, функции, пространства имён и т.д.;

  2. Либо его можно располагать в произвольном месте (и даже другом файле), но для этого потребуется явно указать в нём, к какому элементу кода он относится. Мы не будет рассматривать этот подход, поскольку даже разработчики рекомендуют его избегать, но если интересно, то подробнее о нём можно прочитать в документации.




Структурно, любой документирующий блок является комментарием, просто оформленным специальным образом, поэтому естественно, что его вид зависит от используемого языка (подробнее об этом можно прочитать в соответствующем разделе документации). Поэтому далее мы остановимся на рассмотрении синтаксиса для C-подобных языков (C/C++/C#/Objective-C/PHP/Java).

Вообще, всего существует два типа документирующих блоков: многострочный блок и однострочный блок.


Разница между двумя такими типами чуть более сильная, чем между однострочным и многострочным комментарием. Дело в том, что текст, написанный в однострочном блоке относится к краткому описанию документируемого элемента (сродни заголовку), а текст, написанный в многострочном блоке относится к подробному описанию. Про эту разницу не следует забывать.


Многострочный блок



Мы сказали, что любой блок – это комментарий, оформленный специальным образом. Поэтому необходимо определить каким таким «специальным образом». Вообще, существует целый ряд способов для описания многострочного блока, и выбор конкретного способа зависит от ваших предпочтений:

  1. JavaDoc стиль (напоминает обычный C комментарий, но начинающийся с двух звездочек):

    /**
     * ... первая строчка ...
     * ... вторая строчка ...
     */




    При этом звездочки не обязательно ставить на каждой строке. Такая запись будет эквивалентной:

    /**
     ... первая строчка ...
     ... вторая строчка ...
     */




  2. Qt стиль, в котором в начале вместо второй звёздочки ставится восклицательный знак:

    /*!
     * ... первая строчка ...
     * ... вторая строчка ...
     */




    Сказанное о необязательности промежуточных звездочек также остаётся справедливым. Помимо названных двух стилей есть ещё ряд, но на них пока мы не будем останавливаться.




При этом ещё раз обратите внимание на то, что текст написанный в таком комментарии относится к подробному описанию.

Для указания краткого описания может быть использована команда \brief. Указанный после команды текст, вплоть до конца параграфа будет относится к краткому описания, и для отделения подробного описания и краткого описания используется пустая строка.



/*!
     \brief Краткое описание и
                 его продолжение.

      Подробное описание                  
 */




Однострочный блок



Для описания однострочного блока опять же существует целый ряд способов оформления, рассмотрим два из них:

  1. Можно использовать специальный комментарий в C++ стиле:

    /// Краткое описание




  2. Можно использовать аналогичный предыдущему комментарий, только вместо дополнительного слеша в нем ставится восклицательный знак

    //! Краткое описание





При этом хотелось бы обратить внимание на два момента:

  1. Для указания подробного описания в однострочном документирующем блоке может быть использована команда \details:

    /// \details Подробное описание




  2. Документирующие блоки, следующие друг за другом, объединяются в один (причем вне зависимости от используемого стиля и того, являются они многострочными или однострочными).

    Например следующие два способа документирования дадут один и тот же результат:



    /// \brief Краткое описание
    /// \details Подробное описание



    ///Краткое описание
    /*!
        Подробное описание
    */





Да, Doxygen крайне гибок в плане способов документирования, однако не стоит этим злоупотреблять, и в рамках одного проекта всегда придерживайтесь заранее оговоренного единообразного стиля
Размещение документирующего блока после элемента



Во всех предыдущих примерах подразумевалось, что документирующий блок предварял документируемый элемент, но иногда бывают ситуации, когда удобнее разместить его после документируемого элемента. Для этого необходимо в блок добавить маркер "

int variable; ///< Краткое описание




Пример документации



Теперь рассмотрим то, как это будет выглядеть на практике. Ниже представлен документированный код некоторого класса в соответствии с теми правилами, которые мы рассматривали ранее.

/*!
        \brief Родительский класс, не несущий никакой смысловой нагрузки

        Данный класс имеет только одну простую цель: проиллюстрировать то,
        как Doxygen документирует наследование 
*/
class Parent {
public:
        Parent();
        ~Parent();
};




В итоге Doxygen сформирует на основе данных комментариев следующую красиво оформленную страничку (здесь приведена вырезка из неё):



Теперь, когда мы научились основам, пришла пора познакомиться с тем, как можно детализировать документацию. Инструментом для этого являются команды.

Команды




С насколькими из команд в Doxygen мы успели познакомиться (речь идёт о \brief и \details), однако на самом деле их значительно больше. Полный их список приведён в официальной документации.

Вообще, любая команда в Doxygen представляет собой слово на английском языке предваренное символом "\" или "@" (обе записи тождественны) и таких команд очень много, порядка двухсот. Приведём для примера несколько таких команд:



































Команда Значение
\authorsУказывает автора или авторов
\versionИспользуется для указания версии
\dateПредназначена для указания даты разработки
\bugПеречисление известных ошибок
\warningПредупреждение для использования
\copyrightИспользуемая лицензия
\exampleКоманда, добавляемая в комментарий для указания ссылки на исходник с примером (добавляется после команды)

Пример использования некоторых команд и результат приведены ниже:

/*!
        \brief Дочерний класс
        \author Norserium
        \version 1.0
        \date Март 2015 года
        \warning Данный класс создан только в учебных целях

        Обычный дочерний класс, который отнаследован от ранее созданного класса Parent
*/
class Son : public Parent {
public:
        Son();
        ~Son();
};





Документирование основных элементов исходного кода




Теперь мы можем рассмотреть специфичные особенности документирования различных элементов исходного кода, начиная от файлов в целом и заканчивая классами, структурами, функциями и методами.
Документирование файла



Хорошей практикой является добавление в начало файла документирующего блока, описывающегося его назначение. Для того, чтобы указать, что данный блок относится к файлу необходимо воспользоваться командой \file (причём в качестве параметра можно указать путь к файлу, к которому относится данный блок, но по умолчанию выбирается тот файл, в который блок добавляется, что, как правило, соответствует нашим нуждам).

/*!
\file
\brief Заголовочный файл с описанием классов

Данный файл содержит в себе определения основных 
классов, используемых в демонстрационной программе
*/
#ifndef CLASSES_H
#define CLASSES_H

...

#endif // CLASSES_H




Документирование функций и методов



При документировании функций и методов чаще всего необходимо указать входные параметры, возвращаемое функцией значение, а также возможные исключения. Рассмотрим последовательно соответствующие команды.
Параметры



Для указания параметров необходимо использовать команду \param для каждого из параметров функции, при этом синтаксис команды имеет следующий вид:

\param [<направление>] <имя_параметра> {описание_параметра}




Рассмотрим значение компонентов команды:


  1. Имя параметра – это имя, под которым данный параметр известен в документируемом коде;

  2. Описание параметра представляет собой простое текстовое описание используемого параметра..

  3. Направление – это опциональный атрибут, который показывает назначение параметра и может иметь три значения "[in]", "[out]", "[in,out]";




Сразу же перейдём к примеру:

/*!
Копирует содержимое из исходной области памяти в целевую область память
\param[out] dest Исходная область памяти
\param[in] src Целевая область памяти
\param[in] n Количество байтов, которые необходимо скопировать
*/
void memcpy(void *dest, const void *src, size_t n);




В результате мы получим такую вот аккуратную документацию функции:


Возвращаемое значение



Для описание возвращаемого значения используется команда \return (или её аналог \returns). Её синтаксис имеет следующий вид:

\return {описание_возвращаемого_значения}




Рассмотрим пример с описанием возвращаемого значения (при этом обратите внимание на то, что параметры описываются при помощи одной команды и в результате они в описании размещаются вместе):

/*!
Находит сумму двух чисел
\param a,b Складываемые числа
\return Сумму двух чисел, переданных в качестве аргументов
*/
double sum(const double a, const double b);




Получаем следующий результат:


Исключения



Для указания исключения используется команда \throw (или её синонимы: \throws, \exception), которая имеет следующий формат:

\throw <объект-исключение> {описание}




Простейший пример приведён ниже:

\throw <std::bad_alloc> В случае возникновения ошибки при выделении памяти




Документирование классов



Классы также могут быть задокументированы просто предварением их документирующим блоком. При этом огромное количество информации Doxygen получает автоматически, учитывая синтаксис языка, поэтому задача документирования классов значительно упрощается. Так при документировании Doxygen автоматические определяет методы и члены класса, уровни доступа к функциям, дружественные функции и т.п.

Если ваш язык не поддерживает явным образом определенные концепции, такие как например уровни доступа или создание методов, но их наличие подразумевается и его хотелось бы как-то выделить в документации, то существует ряд команд (например, \public, \private, \protected, \memberof), которые позволяют указать явно о них Doxygen.


Документирование перечислений



Документирование перечислений не сильно отличается от документирования других элементов. Рассмотрим пример, в котором иллюстрируется то, как можно удобно документировать их:

/// Набор возможных состояний объекта
enum States {
         Disabled, ///< Указывает, что элемент недоступен для использования
         Undefined, ///< Указывает, что состояние элемента неопределенно
         Enabled, ///< Указывает, что элемент доступен для использования
}




То есть описание состояний указывается, собственно, после них самих при помощи краткого или подробного описания (в данном случае роли это не играет).

Результат будет иметь следующий вид:


Оформления документации




Теперь, после того, как мы в общих чертах разобрались с тем как документировать основные элементы кода, рассмотрим то, как можно сделать документацию более наглядной, выразительной и полной.
Код внутри документации



Зачастую внутри пояснения к документации необходимо для примера добавить какой-то код, например для иллюстрации работы функции.
Команды \code и \endcode



Один из удобных способов сделать это – команды \code и \endcode, общий формат которой следующий:

\code [ {<расширение>}]
     ...
\endcode




Используемый язык определяется автоматически в зависимости от расширения файла, в котором располагается документирующий блок, однако в случае, если такое поведение не соответствует ожидание расширение можно указать явно.

Рассмотрим пример использования:



/*!
     \brief Алгоритм Евклида
     \param a,b Два числа, чей наибольший делитель мы хотим найти

     Данная функция реализует алгоритм Евклида, при помощи которого
     находится наибольшее общее кратное у двух чисел.

     Код функции выглядит следующим образом:
     \code
     int gcd(int a, int b) {
            int r;
            while (b) {
                  r = a % b;
                  a = b;
                  b = r;
            }
            return r;
     }
     \endcode
*/
int gcd(int a, int b);




Результат будет иметь следующий вид:


Команда \include



Как альтернатива данному способу существует команда \include, общий формат которой имеет следующий вид:

\include <имя_файла>




Она полностью копирует содержимое файла и вставляет его в документацию как блок кода (аналогично предыдущей рассмотренной команде.
Команда \snippet



Команда \snippet аналогична предыдущей команде, однако она позволяет вставлять не весь файл, а его определенный фрагмент. Неудивительно, что её формат несколько другой:

\snippet <имя_файла> ( имя_фрагмента )




Для выделения определенного фрагмента кода необходимо в начале и в конце его разместить документирующий блок с указанием имени фрагмента:

//! [ имя_фрагмента ]
    ...
//! [ имя_фрагмента ]




Формулы с использованием LaTeX



Doxygen позволяет использовать TeX формулы прямо в документации, это очень удобно и результат получается весьма достойным. Однако стоит отметить, что при этом имеются ограничения: на данный момент формулы могут быть вставлены только в HTML и LaTeX документацию, но этого, как правило, вполне достаточно.

На данный момент существует два подхода к отображению формул:



  1. Отображение формул при помощи MathJax, для этого необходимо в файле настроек установить соответствующую опцию:

    USE_MATHJAX  = YES




  2. Генерация соответствующих изображений и вставка их в документацию. Всё это будет сделано автоматически, но вам потребуется следующие инструменты: latex, dvips, gs. По умолчанию формулы отображаются именно этим способом.




Способы добавление формул в документацию



Существуют три способа добавления формул в документацию. Последовательно рассмотрим каждый из них с примерами из документации:

  1. Использование строчных формул, которые обрамляются в начале и в конце при помощи команды "\f$". Пример представлен ниже:

      расстояние между \f$(x_1,y_1)\f$ и \f$(x_2,y_2)\f$ равно \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.




    Результатом будет строка следующего вида: расстояние между и равно

  2. Использование выносных формул, которые начинаются на отдельной строке и центрируются. В отличие от предыдущих формул они обрамляются в начале командой "\f[", а в конце командой "\f[". Пример представлен ниже:

      \f[
        |I_2|=\left| \int_{0}^T \psi(t) 
                 \left\{ 
                    u(a,t)-
                    \int_{\gamma(t)}^a 
                    \frac{d\theta}{k(\theta,t)}
                    \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi
                 \right\} dt
              \right|
      \f]




    Результатом будет строка следующего вида:




  3. Существует команда "\f{environment}", где environment – это название определенного окружения в LaTeX. Она позволяет использовать указанное окружение будто бы оно было указано в обычно LaTeX документе. Пример приведён ниже:

       \f{eqnarray*}{
            g &=& \frac{Gm_2}{r^2} \\ 
              &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\,
                  \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ 
              &=& 9.82066032\,\mbox{m/s}^2
       \f}




    В результате мы получим следующий результат (заметим, что окружение eqnarray* – это ненумерованное окружение для размещения нескольких формул):







Пример внедрения формул в документацию



Рассмотрим конкретный пример документации с использованием формул LaTeX:

/*!
     \brief Вычисление факториала числа \f$ n \f$
     \param n - число, чей факториал необходимо вычислить
     \return \f$ n! \f$

     Данная функция вычисляет значение факториала числа \f$ n \f$, определяемое по формуле:
     \f[
          n! = \prod_{i = 1}^n i
     \f]
*/
int factorial(int n);




Результат представлен ниже:


Кратко о Markdown



Markdown – это облегчённый язык разметки (почитать о нём можно, например, здесь, а также в специальном разделе в документации). Начиная с версии 1.8.0. Doxygen обеспечивает его пока ограниченную поддержку и он служит одним из способов оформить документацию (альтернативой могут быть, например, команды для оформления документации или HTML вставки, которые, впрочем, не универсальны).

Не хотелось бы сейчас расписывать подробности и принципы данного языка, поэтому ограничимся рассмотрением того, как данный язык позволяет «украсить» нашу документацию:



/*!
Функция генерирующая псведослучайное число
------------------------------------------
Изначально планировалось реализовать в данной функции один из следующих методов генерации псевдослучайных чисел:
- Линейный конгруэнтный метод;
- Метод Фибоначчи;
- Линейный регистр сдвига с обратной связью;
- Вихрь Мерсенна.

Но разработчики вспомнили про одну замечательную цитату:
> Есть два способа создания дизайна программы. Один из них, это сделать его настолько простым, что в нем, очевидно, не будет недостатков. Другой способ — сделать его настолько запутанным, что в нем не будет очевидных недостатков.
> — C.A. R. Hoare

И выбрали первый путь.
![Описание функции](image.png)
*/
int getRandomNumber();


Результат представлен ниже:


Подводя итоги




На этой ироничной ноте я решил остановиться. Я прекрасно понимаю, что ещё многое не было описано и затронуто, но, надеюсь, что главные свои цели статья выполнила: познакомить с понятием генератора документации, познакомиться с системой Doxygen, объяснить основные принципы и подходы к документации, а также мельком затронуть вопросы, связанные с её оформление и детализацией, подготовив задел для вашей дальнейшей работы.

Спасибо за внимание!


Литература и ссылки для дальнейшего изучения




image 1. Основным источником, который был использован при написании статьи была официальная документация;

2. На большое количество разнообразных вопросов, связанных с Doxygen, ответы были получены здесь.

This entry passed through the Full-Text RSS service - if this is your content and you're reading it on someone else's site, please read the FAQ at http://ift.tt/jcXqJW.


на
Ярлыки: ,

Комментариев нет:

Отправить комментарий

Подписаться на: Комментарии к сообщению (Atom)