Doxygen의 WYSIWYG

Question

저는 C로 작성된 상당히 큰 프로젝트를 작업 중입니다. 아이디어는 여러 플랫폼에서 재사용 할 수있는 모듈러 블록 라이브러리를 빌드하는 것이 었습니다. 각 모듈은 .docx 형식의 단어 문서와 연관되어 있습니다 (diff-merge에 큰 고통이 있습니다). 이 문서에서는 인터페이스 섹션이 지정되어 데이터 유형 및 공개적으로 액세스 할 수있는 기능을 나열합니다. 이것들은 종종 코드의 실제 구현과 일치하지 않았으며,이 모든 문서를 읽는 것은 고통 스러웠습니다.

저는 문서 관리를 단순화하기 위해 doxygen으로 전환하려고했습니다. 이전에 작성한 문서를 doxygen 출력에 포함시키는 좋은 방법을 찾지 못했습니다. 필자는 코드를 섹션으로 복사하여 모듈을 사용하여 소스를 그룹으로 묶었지만, 주석 부분에서는 문서 섹션이보기 흉하게 보이고 (출력은 꽤), doxygen이 코드 (약 30 분)를 분석하는 데 시간이 걸리기 때문에, 서식을 확인하는 것은 고통입니다.

doxygen에 문서의 큰 블록을 WYSIWYG하는 방법이 있습니까? 나는 이것이 그들의 코드를 문서화하는 사람들의 수와 그 문서의 질을 향상시킬 것이라고 생각한다. html로 연결하는 것을 고려했지만, 문서를 나누었습니다. 나는 또한 html로 인라인하는 것을 고려했다. 그러나 이것 또한 고통처럼 느껴지고 모두가 WYSIWYG HTML 편집기 (또는 일부 html skillz)를 필요로한다.

일을 더 쉽고 더 예쁘게 만드는 방법에 대한 아이디어가 있으십니까?

감사합니다.

Answer 1

문서를 HTML로 인쇄하는 것이 좋습니다. Doxygen은 HTML 문서를 포함 할 수 있으며 최소한 주석과 설명에 HTML 구문을 사용할 수 있습니다.

Answer 2

<pre> ... </pre> 섹션을 주석에 넣고 .css를 약간 조작하여 원하는대로 형식을 지정할 수 있습니다.

Answer 3

내 추가 기능, Atomineer Pro Documentation이 도움이 될 수 있습니다.

(아직) wysiwyg를 제공하지는 않지만, Doxygen 또는 DocXML 설명서 주석을 매일 관리하고 업데이트하는 데 도움이됩니다. 이는 코드 동기화 및 깔끔하고 읽기 쉬운 최소한의 노력으로 계속 유지하는 데 도움이됩니다. - 이것은 일반적으로 번거로운 요소가 최소화되므로 프로그래머가 실제로 문서화하는 결과를 낳습니다.

죄송합니다. 귀하의 문제에 대한 직접적인 해결책은 아니지만, 팀에 내장 된 doxygen 설명을 사용하여 더 효율적이고 효과적으로 작업하게하는 데 도움이 될 수 있습니다.