13
우리가 개발하고 좋은 자바 스크립트 문서 생성기를 찾고있는 자바 스크립트 코드를 문서화하는 중 누군가가 어떤 제안을 가지고 있습니까?자바 스크립트 설명서 생성
우리는 C# 코드에 대한 문서를 작성하기 위해 ndoc을 사용했으며 우리의 js 코드를 문서화하는 것과 비슷한 것을 찾고 있습니다. 이상적으로는 명령 행에서 실행할 수있는 것이 이상적입니다.
미리 감사드립니다.
A
답변
10
유명한 JSDoc-Toolkit을 사용할 수 있습니다.
JsDoc 툴킷은 자동으로 템플릿 포맷 생성하기 위해, 자바 스크립트로 작성된 응용 프로그램입니다, 여러 페이지의 HTML (또는 XML, JSON, 또는 다른 텍스트 기반) 주석 자바 스크립트 소스 코드에서 문서.
그리고 여기에는 command line options도 있습니다.
10
JSDoc은 주석 처리 된 JavaScript에서 문서를 생성하는 방법입니다. 다양한 변형이 있습니다.
- 원래 Perl로 구현되었습니다.
- JSDoc-Toolkit은 JavaScript로 포팅되었지만 Java로 작성된 Rhino JavaScript 엔진을 사용하므로 Java가 필요합니다.
- node.js 자바 스크립트 엔진/플랫폼에서 직접 실행되도록 여러 사용자가 이식했습니다. node-jsdoc-toolkit.
- dox도 node.js에서 실행되며 JSDoc과 유사한 태그와 markdown 태그를 결합하지만 스택 오버플로 및 github에서 사용되는 별도의 템플릿 엔진이 필요합니다.
모두 명령 줄에서 실행됩니다. 툴링 환경 설정에 따라 선택하십시오. 나는 node.js의 속도와 모든 JavaScript-all-the-time 느낌을 좋아한다. DailyJS "프레임 워크를 만들자"post on writing documentation은 이러한 도구와 다른 도구를 설명합니다. 불행히도 dox는 작성된 이후 JSON 구조체를 출력하기 위해 근본적으로 철저히 조사되었습니다.
https://stackoverflow.com/q/1221413/1162195 다른 JavaScript 설명서 생성기를 언급합니다.
+0
@skierpage 링크에 감사드립니다! –
관련 문제
- 1. Crossbrowser 자바 스크립트 + DOM 설명서
- 2. VIM 내에서 사용하기위한 자바 스크립트 설명서 페이지
- 3. 오라클 설명서 생성 도구
- 4. Ruby에 대한 설명서 생성
- 5. xsl 설명서 생성
- 6. jQuery 설명서 생성 방법
- 7. 자바 스크립트 배열 생성
- 8. 자바 스크립트 플러그인 생성
- 9. 자바 스크립트 개체 생성?
- 10. yiidocsgenerator 확장을 사용하여 설명서 생성
- 11. PHP로 자바 스크립트 파일 생성
- 12. 자바 스크립트 객체 생성 메소드
- 13. Ajax 동적으로 생성 + 자바 스크립트
- 14. 방지 자바 스크립트 생성 클릭
- 15. 자바 스크립트 객체 생성/연관성
- 16. 자바 스크립트 문자열 생성 오류
- 17. 자바 스크립트 오류 색인 생성
- 18. 내가 자바 스크립트 클래스를 생성
- 19. 자바 스크립트 플러그인 생성 방법
- 20. 동적 자바 스크립트 객체 생성
- 21. RubyDoc.info 또는 YARD 같은 자바 스크립트 설명서 생성기?
- 22. ReST 웹 서비스 설명서/WADL 자동 생성
- 23. 야드 및 스페인어 액센트가 생성 한 설명서
- 24. 자바 스크립트 : 자바 스크립트
- 25. 자바 스크립트 : 자바 스크립트
- 26. 자바 스크립트 생성 됨 보안 문자
- 27. 자바 스크립트 요청에 대한 세션 키를 생성
- 28. 함수를 사용하여 자바 스크립트 객체 생성
- 29. HAML 내에서 동적으로 생성 된 자바 스크립트
- 30. 자바 스크립트 splice() 색인 생성 문제
[이 질문] (http://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript)도 확인하시는 것이 좋습니다 –