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

Ответ 1

Вы можете использовать /** <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})

Источники:

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

Ответ 2

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