Doxygen for Mac - Download

나는 수년간 내 사이드 ​​프로젝트의 오래되었거나 누락된 문서로 인해 씨름해 왔습니다. 이는 6개월 동안 건드리지 않은 코드를 디버깅하려고 하다가 갑자기 주석이 사라진 것과 같습니다. 그때 Mac용 Doxygen - Mac용 다운로드를 찾았습니다. 솔직히 화려하지는 않지만 작동합니다. 나는 그것을 떨어뜨려 몇 가지 잘 배치된 주석과 함께 C++ 프로젝트에서 실행했습니다. // 그리고 굉장한 일이었습니다. HTML 문서는 1분 안에 준비되었습니다. 설정 마법사도 없고 로그인도 필요 없으며 가리키기만 하면 됩니다.

좋은 것들

실제로 클릭한 것은 출력이 얼마나 깨끗한지였습니다. /// 또는 /** */를 사용하여 표준 C 스타일 주석을 작성할 수 있으며 Doxygen은 함수 설명, 매개변수, 반환 유형을 모두 잘 형식화하여 가져옵니다. 나는 그것을 작은 Python 스크립트에도 사용했고 Python이 공식적으로 지원되지 않더라도 여전히 독스트링을 적절하게 구문 분석했습니다. 진짜 승리는? 문서를 생생하게 유지합니다. 변경 사항을 적용할 때마다 Doxygen을 다시 실행하면 문서가 자동으로 업데이트됩니다. 더 이상 "잠깐, 이 기능은 무엇을 하는 거죠?" 팀 검토 중 순간.

그리고 구성은? 간단하지만 유연합니다. .cfg 파일을 조정하여 특정 파일을 무시하고, 헤더를 포함하고, 출력 형식(HTML, LaTeX, RTF)을 설정하면... 실행됩니다. 나는 그것을 Javadoc 및 Sphinx와 비교했는데, 그것들은 더 많은 부가 기능을 가지고 있지만 Doxygen은 도구와 싸우고 있다는 느낌을 주지 않고 작업을 완료합니다.

그다지 좋지 않은 것

초보자에게 친숙하지 않습니다. 명령줄 도구를 처음 사용하는 경우 설정이 어색하게 느껴질 수 있습니다. GUI 구성 패널이 없습니다. 텍스트 파일을 편집합니다. 그리고 기본 템플릿은… 베어본입니다. 개발자가 아닌 사람들에게 CSS나 레이아웃을 보여주려면 CSS나 레이아웃을 조정하는 것이 좋습니다. 그리고 버전 정보나 다운로드 통계가 부족한 것도 이상하네요. 나는 그것이 유지되고 있는지 확인하기 위해 주위를 파헤쳐야했습니다. 하지만 무료이므로 가져가겠습니다.

작은 스크립트를 혼자 작업하고 공식적인 문서에 관심이 없다면 건너뛰세요. GUI의 모든 것을 선호하는 경우에도 마찬가지입니다. 하지만 당신이 팀의 일원이거나 더 큰 것을 만들고 있다면 이것은 조용한 생명의 은인입니다.

결론

Mac용 Doxygen - Mac용 다운로드를 찾고 있다면 구입하세요. 무료이고 안정적이며 해당 카테고리의 대부분의 것보다 코드 문서를 더 잘 처리합니다. 특히 손으로 문서를 작성하는 데 지쳤다면 더욱 그렇습니다. 이것은 보풀이 없이 결과만 유지합니다. 확실히 설치하는데 30초 투자할 가치가 있습니다.