Clion: automatische Dokumentation von Funktionen, Klassen

Gibt es eine Verknüpfung oder ähnliches zum Hinzufügen, z. B. Dokumentation einer Funktion oder Klasse (ähnlich wie "///" in Visual Studio und C#)?

Vielen Dank!

Sie können verwenden /** <Enter>.
Ich habe einen Weg gefunden, es zu tun. Ich persönlich benutze Doxygen für die Dokumentation.
CLion plant, es zu integrieren. Sie müssen das alles zu diesem Zeitpunkt schreiben. Aber wenn Sie Ihren Code dokumentiert haben, können Sie ihn mit CMake erstellen (und dann erscheint er in Ihrem Erstellungsziel auf CLion).

Hier ist ein Beispiel:

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})

Quellen:

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/

Ab 2016.2 unterstützt EAP CLion Doxygen (http://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/). Beginnen Sie mit der Eingabe von „/**“ oder „/*!“ und drücken Sie dann die Eingabetaste. Falls Ihre Funktion Parameter hat, einen Wert zurückgibt oder eine Ausnahme auslöst, erhalten Sie einen Stub, den Sie mit dem Dokumentationstext füllen können