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 )