appledoc
2.2.1 build 1333
중요 공지: 협력자가 필요합니다
appledoc은 Objective-C 개발자가 특별히 형식화된 소스 코드 주석에서 Apple과 유사한 소스 코드 문서를 생성하는 데 도움이 되는 명령줄 도구입니다. 입력에 대해 가능한 한 읽을 수 있는 소스 코드 주석을 사용하고 주석과 주변 소스 코드를 사용하여 HTML 형식의 시각적으로 매력적인 문서와 완전히 색인화되고 탐색 가능한 Xcode 문서 세트를 생성하도록 설계되었습니다. Objective-C용 HTML 문서를 생성할 수 있는 도구는 여러 가지가 있지만 제가 알고 있는 모든 도구는 아래 설명된 최소 목표를 충족하는 데에는 부족합니다.
appledoc의 주요 목표:
appledoc을 최대한 원활하게 사용하려면 이 문서 전체와 아래 "appledoc 사용" 섹션에 언급된 모든 온라인 문서를 읽어 보시기 바랍니다!
이 파일 하단의 LICENSE 섹션에 나열된 조건에 따라 appledoc 사용이 허용됩니다!
계속해서 업데이트하고 싶으신가요? 트위터에서 @gentlebytes를 팔로우하세요.
권장되는 방법은 GitHub 프로젝트를 복제하고 Xcode에서 도구를 컴파일하는 것입니다. GitHub 프로젝트를 복제하면 기본 저장소에 대한 링크가 생성되므로 향후 업그레이드도 크게 단순화됩니다. 설치하려면 터미널에 다음을 입력하세요.
git clone git://github.com/tomaz/appledoc.git
그러면 appledoc 디렉토리가 생성됩니다. 그 안에서 appledoc.xcworkspace Xcode 작업공간을 찾을 수 있습니다. 그것을 열고 appledoc 대상을 컴파일하십시오. 이것은 기본적으로 작동하지만 시스템은 최소 시스템 요구 사항을 충족해야 합니다. 아래를 참조하십시오. 쉽게 액세스할 수 있도록 빌드 디렉터리의 결과 appledoc 실행 파일을 경로( echo $PATH )의 디렉터리 중 하나로 복사하는 것이 좋습니다.
선택 사항: Appledoc은 독립적이며 필요한 템플릿 파일을 포함합니다. Templates 하위 디렉터리의 기본값을 예상 위치 중 하나로 수정하려면 다음을 수행하세요.
install-appledoc.sh 스크립트를 사용하여 빠른 설치를 수행할 수도 있습니다. 터미널을 열고 appledoc 디렉토리로 전환하십시오. 다음 명령을 입력하십시오.
sudo sh install-appledoc.sh (if you need templates add '-t default')
기본적으로 appledoc를 컴파일하고 해당 바이너리를 /usr/local/bin에 설치하고 템플릿(원하는 경우)을 ~/.appledoc에 설치합니다. -b 및 -t 옵션을 각각 사용하여 이 디렉터리를 재정의할 수 있습니다. 예를 들어:
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
또는 Homebrew를 사용하면 다음과 같습니다.
brew install appledoc
Homebrew는 기본적으로 템플릿을 설치하지 않습니다.
모든 명령줄 스위치 목록을 보려면 appledoc --help 사용하십시오. appledoc 사이트에서 appledoc에 대해 자세히 알아보세요. 또한 좀 더 심층적인 기사를 보려면 위키 페이지를 읽어보세요.
사용법에 관한 질문이나 기타 일반적인 질문을 위한 포럼으로 appledoc Google 그룹을 사용하세요.
버그 및 기능 요청을 제출하려면 appledoc 문제 페이지를 사용하세요. 새 문제를 제출하기 전에 포럼에서 질문에 대한 답변이 있는지 확인하세요. 문제를 새로운 기능 요청이나 버그로 확인할 수 없는 한 포럼에서 시작하여 GitHub 문제를 깔끔하게 유지해야 합니다. 또한 이슈를 읽어보고 이슈가 이미 있는지 확인하고 투표하거나 댓글을 추가하세요(종료된 이슈도 잊지 마세요).
최신 상태를 유지하려면 터미널로 이동하여 appledoc 디렉토리로 이동한 후 git pull 실행하고 appledoc.xcodeproj를 다시 컴파일하세요. $PATH에 복사한 appledoc 실행 파일을 덮어쓰는 것을 잊지 마세요 :)
AppledocTests(단위 테스트) 대상도 컴파일하고 실행하려면 단위 테스트 대상을 빌드하기 전에 라이브러리 및 프레임워크 그룹에 표시된 모든 프레임워크를 공유 프레임워크 디렉터리에 복사해야 합니다! 이는 appledoc 도구 자체를 구축하는 데 필요하지 않습니다.
Appledoc 문서 생성을 자동화하도록 Xcode를 설정할 수 있습니다. 실행 스크립트와 프로젝트의 빌드 단계를 사용하는 방법을 알아보세요.
대부분의 Cocoa 프레임워크에 대해 사전 생성된 문서 및 문서 세트는 다음에서 사용할 수 있습니다.
문서 세트가 있으면 문서 브라우저에서 이를 사용할 수 있습니다.
문제가 있나요? 문제를 해결하기 위해 수행할 수 있는 작업은 다음과 같습니다.
git pull 시도하고 최신 버전으로 다시 실행해 보세요.--verbose 명령줄 스위치를 사용하여 자세한 정보 수준을 높입니다. 기본 수준은 2이지만 각 수준마다 자세한 정보를 최대 6까지 점진적으로 증가시켜 더 자세한 정보를 제공할 수 있습니다. 이렇게 하면 훨씬 더 많은 정보를 얻을 수 있으므로 문제가 있는 특정 소스 파일 세트에만 집중할 수 있습니다. 자세한 정보를 늘리면 성능이 저하되므로 매일 사용하는 데 4 이상의 수준을 사용하는 것은 권장되지 않습니다.기여하고 싶다면 Appledoc이 내부적으로 어떻게 작동하는지에 대한 간략한 개요를 보려면 개발자 노트 파일을 참조하세요.
appledoc은 수정된 BSD 라이선스로 라이선스가 부여됩니다. 일반 언어로 설명하면 코드를 사용하여 원하는 모든 작업을 수행하고 수정, 재배포, 제품에 포함(무료 또는 상업용)할 수 있지만 라이센스에 명시된 대로 저작권, 사용 조건 및 면책 조항을 포함해야 합니다. 다른 BSD 라이센스 코드와 동일합니다. 물론 귀하의 제품(무료 또는 상업용)에 대해 appledoc에서 생성된 문서를 사용할 수 있지만, 문서 자체나 귀하의 웹 사이트와 같은 다른 적절한 위치에 appledoc을 표시해야 합니다.
어떤 이유로든 이 약관에 동의할 수 없는 경우 정보 페이지의 문의 양식을 통해 문의해 주세요. 최선을 다해 도움을 드리고 실행 가능한 해결책을 찾도록 하겠습니다!
저작권 (c) 2009-2011, Gentle Bytes 모든 권리 보유.
다음 조건이 충족되는 경우 수정 여부에 관계없이 소스, 바이너리 형식 및 생성된 문서의 재배포 및 사용이 허용됩니다.
소스 코드를 재배포할 경우 위의 저작권 고지, 본 조건 목록 및 다음 면책 조항을 유지해야 합니다.
바이너리 형식으로 재배포할 경우 배포와 함께 제공되는 문서 및/또는 기타 자료에 위의 저작권 고지, 이 조건 목록 및 다음 면책 조항을 재현해야 합니다.
appledoc에 의해 생성된 문서의 재배포에는 문서 자체 또는 기타 적절한 매체에 appledoc에 대한 귀속이 포함되어야 합니다.
구체적인 사전 서면 승인 없이는 appledoc의 이름, Gentle Bytes 또는 그 기여자의 이름을 사용하여 이 소프트웨어에서 파생된 제품을 보증하거나 홍보할 수 없습니다.
이 소프트웨어는 저작권 보유자 및 기여자에 의해 "있는 그대로" 제공되며, 상품성 및 특정 목적에의 적합성에 대한 묵시적인 보증을 포함하되 이에 국한되지 않는 모든 명시적 또는 묵시적 보증은 부인됩니다. 어떠한 경우에도 저작권 보유자나 기여자는 직접적, 간접적, 부수적, 특별, 예시적 또는 결과적 손해(대체 상품이나 서비스의 조달, 사용, 데이터 또는 이익의 손실을 포함하되 이에 국한되지 않음)에 대해 책임을 지지 않습니다. 또는 사업 중단) 원인에 관계없이 이 소프트웨어의 사용으로 인해 발생하는 계약상, 엄격한 책임 또는 불법 행위(과실 또는 기타 포함)에 관계없이 책임 이론에 따라 발생합니다. 이는 그러한 손해의 가능성이 통보된 경우에도 마찬가지입니다.
젠틀 바이트 [email protected]
