헤더 문서

HeaderDoc
헤더 문서
개발자애플사
초기 릴리즈2000년 9월 13일
안정된 릴리스
8.9 / 2009년6월 8일
기입처Perl, C(헬퍼)
운영 체제Mac OS X, UNIX, Linux
유형문서 생성기
면허증.Apple Public Source License 2.0
웹 사이트developer.apple.com/opensource/tools/headerdoc.html

HeaderDoc은 Apple Inc.가 개발하고 관리하는 문서 생성기입니다.HeaderDoc은 특별히 주석이 달린 소스 코드 파일을 입력으로 사용하여 HTML 또는 XML 형식으로 코드에 대한 문서를 생성합니다.HeaderDoc 코멘트 태그의 구문은 HeaderDoc 버전8에서 Javadoc 태그를 지원하는 것과 거의 비슷합니다.HeaderDoc 8.7 이후에서는 다수의 Doxygen 태그(@ 형식만 해당하며 HeaderDoc 태그 순서 규칙에 따라야 합니다)도 부분적으로 지원됩니다.Apple HeaderDoc 프로젝트는 Apple Public Source License에 따라 배포되는 무료 오픈 소스 소프트웨어입니다.

지원되는 플레인 텍스트 언어

HeaderDoc 도구 세트는 기본 유틸리티인 headerdoc2html 및 gatherheaderdoc으로 구성됩니다.headerdoc2html 도구는 지정된 코멘트 첨부 소스 파일에서 HTML(또는 XML) 파일의 디렉토리를 생성합니다.그 후 gatherheaderdoc 유틸리티를 실행하여 문서용 목차 파일을 작성할 수 있습니다.마지막으로 resolveLinks 유틸리티를 사용하여 여러 문서 모음 간의 상호 참조를 해결할 수 있습니다.

Apple의 Xcode 개발 환경에는 HeaderDoc 구문 및 도구를 사용하여 문서를 작성하는 프로세스를 지원하도록 설계된 기능이 포함되어 있습니다.

기타 기능

HeaderDoc에는 다음과 같은 핵심 기능이 있습니다.

  • C 전처리를 통해 사용자가 선택한 #define 매크로로 콘텐츠를 변경할 수 있으며 사용자가 명령줄 플래그를 전달하여 입력의 일부를 무시할 수 있습니다.
  • 사용자 정의 스타일을 사용한 구문 색칠.
  • 인덱스의 템플릿 기반 랜딩 페이지.
  • 크로스 플랫폼(주로 Perl로 작성).

HeaderDoc 스위트에는 독립적으로 사용할 수 있는 다음과 같은 도구도 포함되어 있습니다.

  • MPGL: XHTML의 서브셋과 섹션 태그, 파라미터 태그 등으로 구성된 경량 XML 구문을 사용하여 UNIX 매뉴얼 페이지 작성을 단순화하는 도구 세트입니다.HeaderDoc은 또한 HeaderDoc의 XML 출력 모드를 통해 함수의 헤더 코멘트로부터 수동 페이지를 생성할 수 있는 브리징 도구도 제공합니다.
  • resolveLinks: 임베디드 앵커 및 링크 요청을 사용하여 콘텐츠가 다른 주소로 이동했을 때 웹 사이트를 신속하게 재링크할 수 있는 도구입니다.
  • 필터마크로스pl:C 프리프로세서 매크로에 근거해 헤더의 섹션을 필터링 하기 위해서 사용할 수 있는 툴.이것은 현재 소스 tarball을 다운로드해야만 사용할 수 있습니다.HeaderDoc 8.9에서 이 기능은 Headerdoc2html 도구 자체에 포함되어 있습니다.

「 」를 참조해 주세요.

외부 링크

Stub icon

이 프로그래밍 도구 관련 기사는 스텁입니다.위키피디아를 확장함으로써 위키피디아를 도울 수 있습니다.