Документирование кода
Поддерживайте свой код хорошо документированным. В этом вам поможет CLion и встроенная поддержка одного из самых популярных форматов документирования кода — Doxygen.
Предварительный просмотр документации
Во всплывающем окне Quick Documentation (Ctrl+Q) теперь можно просматривать документацию Doxygen. В дополнение к информации о типе элемента в окне удобно отображается документация в формате Doxygen.
Если параметры функции в коде задокументированы отдельно, CLion сможет объединить все комментарии и показать общее описание сигнатуры (так же, как это делает Doxygen при генерации вывода).
Безопасное переименование
Чтобы сохранить правильность документации, используйте рефакторинг Rename Shift + F6, если вы решите переименовать функцию или ее параметр. Комментарии Doxygen будут автоматически обновлены.
Автодополнение
Чтобы печатать быстрее, воспользуйтесь автодополнением для команд Doxygen и параметров функций.
Генерация документации
Чтобы добавить новый комментарий Doxygen для функции, просто сгенерируйте его. Введите /**, /*!, /// или //! и нажмите Enter. Так сгенерируется шаблон документации для дальнейшего заполнения, при условии, что у документируемой функции есть параметры, она возвращает значение или кидает исключение.
Быстрый просмотр документации
- информация о сигнатуре функции;
- документация (обычная либо комментарии Doxygen);
- выведенные типы — особенно полезно для современного C++, где типы не всегда указываются явно;
- размер типа;
- подстановки макросов, — позволяет лучше понимать и отлаживать вложенные макросы;
- значения константных выражений;
- значение перечисления (
enum) в виде целого числа.