Clion: funzioni di documentazione automatica, classi

Question

C'è qualche collegamento o qualcosa di simile da aggiungere, ad es. documentazione di una funzione o classe (simile a "///" in Visual Studio e C#)?

Grazie!

Answer 1

È possibile utilizzare /** <Enter>.
Ho trovato un modo per farlo. Io personalmente uso Doxygen per la documentazione.
CLion plans to integrate it. Devi scrivere tutto in questo momento. Ma quando hai documentato il tuo codice, puoi crearlo con CMake (e poi apparire nel tuo obiettivo di build su CLion).

Ecco un esempio:

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

Fonti:

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/

Answer 2

A partire dal 2016.2 EAP CLion supporta Doxygen (http://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/). Inizia a digitare "/ **" o "/ *!", Quindi premi Invio. Se la tua funzione ha parametri, restituisce un valore o genera un'eccezione, riceverai uno stub da riempire con il testo della documentazione