Doxygen for Mac - Download

그럼 당신은 개발자죠? 당신은 탄탄한 코드베이스를 갖고 있지만 문서를 작성하지 않는 한 누구도 그것을 읽지 않을 것입니다. 그리고 손으로 해야 한다면 신이 도와주세요. 이것이 바로 Doxygen이 등장하는 이유입니다. 저는 주로 Python과 C++와 같은 몇 가지 사이드 프로젝트에서 Doxygen을 사용했는데 솔직히 말해서 시간을 절약해주었습니다. 코드를 스캔하고, 주석을 꺼내고, 함수 목록, 클래스 계층, 심지어 호출 그래프가 포함된 깔끔한 HTML 페이지를 구축합니다. 마술은 아니지만 작동합니다.

좋은 것들

정말 마음에 들었던 점은 지저분한 댓글이 실제로 사용할 수 있는 내용으로 얼마나 빨리 바뀌었는지였습니다. 예를 들어, 15개의 함수가 포함된 헤더 파일이 있었는데 모두 다음과 같이 문서화되었습니다.///또는/** */. Doxygen, boom - 즉시 탐색 가능한 HTML 사이트를 실행하세요. 위키에 복사하여 붙여넣거나 별도의 마크다운 파일을 유지할 필요가 없습니다. 출력도 괜찮아 보입니다. 화려하지는 않지만 기능적입니다. 팀으로 작업하는 경우 Slack 메시지를 통해 각 기능의 기능을 설명하는 것보다 훨씬 쉽습니다. 또한 여러 언어를 지원하므로 제가 본 일부 도구처럼 C++에만 해당되는 것은 아닙니다.

그다지 좋지 않은 것

네, 무료입니다. 정말 좋습니다. 하지만 학습 곡선은 0이 아닙니다. 구성 파일(Doxyfile)은 처음에는 부담스러울 수 있습니다. 경로를 조정하고, 출력 형식을 선택하고, 기호 가시성을 설정해야 합니다. PDF 출력이 작동하기까지 두 번의 시도가 필요했습니다. 그리고 GUI가 없습니다. 명령줄만 있으면 됩니다. 따라서 터미널을 싫어하는 사람이라면 이것이 투박하게 느껴질 수도 있습니다. 또한 생성된 문서는 귀하의 의견이 맞는 경우에만 정확합니다. 함수 문서화를 건너뛰면 Doxygen은 함수가 무엇을 하는지 추측하지 않습니다. 그리고 이 도구는 IDE와 잘 통합되지 않습니다. 수동으로 실행하거나 스크립트를 작성해야 합니다. 끔찍하지는 않지만 부드럽지도 않습니다.

결론

개인 프로젝트든 팀 저장소든 다른 사람이 만질 수 있는 코드를 작성하고 있다면 Mac용 Doxygen - Windows용 다운로드는 다운로드할 가치가 있습니다. 무료이고 작동하며 "이 기능은 무엇을 하는가?"라는 질문을 줄여줍니다. 혼돈. 가장 화려한 도구는 아니지만 소란 없이 작업을 완료합니다. 일회용 스크립트를 작성하거나 CLI 도구를 싫어하는 경우에만 건너뛰십시오. 그렇지 않으면 시도해 보세요. 나중에 스스로에게 감사하게 될 것입니다.