1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/ApolloAuto-apollo

Клонировать/Скачать
how_to_document_code.md 3 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 26.11.2024 18:11 27a44e0

Как документировать исходный код в Apollo

Apollo использует Doxygen для документирования исходного кода. Разработчики, которые не знакомы с Doxygen, могут обратиться к официальному руководству Doxygen (https://www.doxygen.nl/manual/index.html) для получения глубоких знаний о документировании кода с помощью Doxygen. Этот документ служит кратким вариантом руководства по Doxygen: Документирование кода (https://www.dxygen.nl/manual/docblocks.html), фокусируясь конкретно на C/C++ и Python.

Мы рассмотрим файл modules/common/math/kalman_filter.h в качестве примера, чтобы показать вам, как документировать код способом Doxygen. Обратите внимание, что стиль Javadoc предпочтительнее стиля Qt для блоков комментариев.

Файл

/**
 * @file
 * @brief Определяет шаблонный класс KalmanFilter.
*/

Пространство имён

/**
* @namespace apollo::common::math
* @brief apollo::common::math
*/

namespace apolo {
namespace common {
namespace math {

Класс

/**
* @class KalmanFilter
*
* @brief Реализует дискретный фильтр Калмана.
*
* @param XN размерность состояния
* @param ZN размерность наблюдений
* @param UN размерность управления
*/
template <typename T, unsigned int XN, unsigned int ZN, unsigned int UN>
class KalmanFilter {
 public:
 ...

Функция

  /**
   * @brief Устанавливает начальное распределение убеждений состояния.
   *
   * @param x Среднее распределения убеждений состояния
   * @param P Ковариация распределения убеждений состояния
   */
  void SetStateEstimate(const Eigen::Matrix<T, XN, 1> &x,
                        const Eigen::Matrix<T, XN, XN> &P) {
    ...
  }

  /**
   * @brief Получить начальное состояние фильтра
   * @return Истина, если фильтр инициализирован
   */
  bool IsInitialized() const { return is_initialized_; }

Общедоступные / защищённые переменные-члены класса

 protected:
  /// Среднее текущего распределения убеждений состояния
  Eigen::Matrix<T, XN, 1> x_;

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

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/ApolloAuto-apollo.git
git@api.gitlife.ru:oschina-mirror/ApolloAuto-apollo.git
oschina-mirror
ApolloAuto-apollo
ApolloAuto-apollo
master