Clion: функции автоматического документирования, классы

Есть ли какой-нибудь ярлык или что-то вроде этого, например, чтобы добавить документирование функции или класса (аналогично "///" в Visual Studio и C #)?

Спасибо!

12

Решение

Ты можешь использовать /** <Enter>,
Я нашел способ сделать это. Я лично использую Doxygen для документации.
CLion планирует интегрировать его.
Вы должны написать все это в это время. Но когда вы задокументировали свой код, вы можете собрать его с помощью CMake (а затем он появится в вашей целевой сборке на CLion).

Вот пример:

cmake_minimum_required(VERSION 3.2)
project(doxygen_test)

find_package(Doxygen)

set(SOURCE_FILES main.cc)

if(DOXYGEN_FOUND)

set(DOXYGEN_INPUT ${SOURCE_FILES})
set(DOXYGEN_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

add_custom_command(
OUTPUT ${DOXYGEN_OUTPUT}
COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation..."COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_INPUT}
COMMAND ${CMAKE_COMMAND} -E echo "Done."WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
DEPENDS ${DOXYGEN_INPUT}
)

add_custom_target(apidoc ALL DEPENDS ${DOXYGEN_OUTPUT})

add_custom_target(apidoc_forced
COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation..."COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_INPUT}
COMMAND ${CMAKE_COMMAND} -E echo "Done."WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

endif(DOXYGEN_FOUND)

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")add_executable(doxygen_test ${SOURCE_FILES})

Источники:

  1. http://www.cmake.org/pipermail/cmake/2007-February/012796.html
  2. https://www.tty1.net/blog/2014/cmake-doxygen_en.html
  3. https://mementocodex.wordpress.com/2013/01/19/how-to-generate-code-documentation-with-doxygen-and-cmake-a-slightly-improved-approach/
  4. https://majewsky.wordpress.com/2010/08/14/tip-of-the-day-cmake-and-doxygen/
11

Другие решения

Начиная с 2016.2 EAP CLion поддерживает Doxygen (http://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/). Начните с ввода «/ **» или «/ *!», А затем нажмите Enter. Если ваша функция имеет параметры, возвращает значение или выдает исключение, вы получите заглушку для заполнения текстом документации

3

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector