15

"///"関数やクラスのドキュメント ( Visual Studio や C# と同様) など、追加するショートカットやこのようなものはありますか?

ありがとう！

4

2 に答える 2

14

使用できます/** <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/
于 2015-08-10T13:43:28.690 に答える
7

2016.2 以降、EAP CLion は Doxygen をサポートしています ( http://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/ )。「/**」または「/*!」と入力して開始します。Enter キーを押します。関数にパラメーターがある場合、値を返す場合、または例外をスローする場合は、ドキュメント テキストを入力するスタブを取得します。

于 2016-05-25T21:50:59.680 に答える