나는 크게 문서화되어야하는 대부분의 절차 코드가 있습니다. 이것은 일반적으로 특정 순서로 실행되어야하는 많은 기능을 반복적으로 사용하는 것을 포함합니다.절차 프로그램을위한 Doxygen
Doxygen은 훌륭한 제품이지만 OOP 코드를 문서화하는 데 매우 중점을 둔 것처럼 보입니다. 누구든지 절차 작업을 문서화하기 위해 자연스럽게 doxygen을 사용하는 방법에 대한 조언이 있습니까?
doxygen이 작동하는 방식에 대해 본질적으로 아무 것도 없습니다. OO 코드에 더 많은 정보가 있기 때문에 더 많은 정보를 추출 할 수 있습니다 (예 : 상속 그래프).
우리는 일반 C 코드에 doxygen을 사용하고 C++과 비교했을 때 일반 C가 제공하지 않는 정보는 빼고 작동합니다. 생성 된 문서를 구성하기 위해 doxygen의 그룹화 (@addtogroup 등) 기능을 사용하면 좋을 것입니다.
그렇다면 열거 유형의 것들은 개별 기능을 문서화하거나 그룹화하는 것이 아니라 실제로 어떤 순서로 표시하는 것입니까? 예를 들어, 프로그램의 주요 반복 부분은 20-40 개의 함수를 특정 순서로 호출해야합니다. 내가하고있는 일을 설명하는 하나의 커다란 루틴에서 각 함수 호출 위에 주석 블록을 붙일 수 있고 커다란 루틴의 출력을 정렬 된 목록으로 만들 수 있기를 원합니다. – Aurelius
특정 순서로 호출해야하는 함수가 많은 경우 해당 함수 API에 * that *을 문서화해야합니다 - 아마도 그룹으로 함께 그룹화하고 그룹 설명이 어떻게되어 있는지 말하도록해야합니다 함께 사용하십시오. 하지만 전화 사이트에서 그 사실을 문서로 나타내지는 않습니다. – vanza
고마워, 나는 이것을 오늘 시험해보고 그것이 어떻게 작동하는지 보게 될 것이다. CUDA 프로그램이므로 호출 사이트에서 문서화하는 것이 더 좋았습니다. 그리드/스레드/메모리 인수를 추가하여 커널을 호출하는 방법은 커널 자체의 동작을 변경합니다. 즉, 기능 자체에서 보이지 않는 정보/인수가 호출 사이트에 존재한다. – Aurelius
이러한 기능을 특정 순서로 실행해야하는 경우에는 래퍼를 작성하십시오. – user877329