2017.07.19

모질라, 파이선 스타일의 프로젝트 문서화 플러그인 발표

Paul Krill | InfoWorld
대형 자바 스크립트 프로젝트를 위한 모든 기능을 갖춘 문서화 도구를 원하는 모질라가 Sphinx js를 발표했다. Sphinx는 파이선 세계에서 사용되는 Sphinx 문서화 도구로 JSD 형식 자바 스크립트 문서화 플러그인이다.

Sphinx -js는 자바스크립트 API와 라이브러리를 문서화하는 JSDoc 마크업 언어에서 문서와 태그를 수집한다. 분석은 JSDoc 자체에 위임한다. Sphinx 도구는 그러나 프로젝트의 루트 폴더 안의 문서 폴더 이니셜라이징에 사용되며, 그 결과 플러그인이 활성화되고, 단순 텍스트 컴퓨터 구문과 분석 시스템에 쓰이는 코드를 문서화할 수 있다.

모질라의 에릭 로즈는 “추출한 문서화를 호출할 때, Sphinx-js의 특별 명령어를 사용할 수 있다. 이 명령어는 파이선 중심의 autodoc이 성숙하게 진화한 모델”이라고 말했다. 문서화와 자바스크립트 도구는 양립할 수 있다.

개발자들은 reStructuredText 파일에 있는 긴 예제를 추가하고 매뉴얼을 구성할 수 있다. Sphinx-js는 또한, ECMAScript 2015나 명령어 기능에서도 클래스 명령어를 지정할 수 있다. 옵션으로 클래스 멤버나 문서화를 반복할 수도 있다. 명령도 통제할 수 있다. 레퍼런스는 같은 이름의 자바스크립트 개체를 지원한다.

로즈는 JSDoc이 잘 정의된 태그로 일반적인 구조를 설명할 수 있고, 클로저 컴플라이어 등의 툴로 태그를 묶는 등 좋은 기능이 많다고 말했다. 그러나 여전히 결과물은 프로젝트 내용물의 알파벳 정렬 목록으로 나타난다. 기능도 평범해서 새로운 사용자가 관계와 정렬을 직접 추론해야 한다. 소규모 라이브러리에서는 문제가 없을 수 있지만, 패덤 프레임워크 같은 대규모 라이브러리에는 부족한 부분이 있을 수 있다.

Sphinx-js 플러그인은 파이선 패키지 인덱스에서 무료로 다운로드할 수 있다. Sphinx-js는 JSDoc의 지원 범위를 넘어 자바스크립트 문서화 도구에 대한 높은 수요로 탄생한 것이나 다름없다. editor@itworld.co.kr 


2017.07.19

모질라, 파이선 스타일의 프로젝트 문서화 플러그인 발표

Paul Krill | InfoWorld
대형 자바 스크립트 프로젝트를 위한 모든 기능을 갖춘 문서화 도구를 원하는 모질라가 Sphinx js를 발표했다. Sphinx는 파이선 세계에서 사용되는 Sphinx 문서화 도구로 JSD 형식 자바 스크립트 문서화 플러그인이다.

Sphinx -js는 자바스크립트 API와 라이브러리를 문서화하는 JSDoc 마크업 언어에서 문서와 태그를 수집한다. 분석은 JSDoc 자체에 위임한다. Sphinx 도구는 그러나 프로젝트의 루트 폴더 안의 문서 폴더 이니셜라이징에 사용되며, 그 결과 플러그인이 활성화되고, 단순 텍스트 컴퓨터 구문과 분석 시스템에 쓰이는 코드를 문서화할 수 있다.

모질라의 에릭 로즈는 “추출한 문서화를 호출할 때, Sphinx-js의 특별 명령어를 사용할 수 있다. 이 명령어는 파이선 중심의 autodoc이 성숙하게 진화한 모델”이라고 말했다. 문서화와 자바스크립트 도구는 양립할 수 있다.

개발자들은 reStructuredText 파일에 있는 긴 예제를 추가하고 매뉴얼을 구성할 수 있다. Sphinx-js는 또한, ECMAScript 2015나 명령어 기능에서도 클래스 명령어를 지정할 수 있다. 옵션으로 클래스 멤버나 문서화를 반복할 수도 있다. 명령도 통제할 수 있다. 레퍼런스는 같은 이름의 자바스크립트 개체를 지원한다.

로즈는 JSDoc이 잘 정의된 태그로 일반적인 구조를 설명할 수 있고, 클로저 컴플라이어 등의 툴로 태그를 묶는 등 좋은 기능이 많다고 말했다. 그러나 여전히 결과물은 프로젝트 내용물의 알파벳 정렬 목록으로 나타난다. 기능도 평범해서 새로운 사용자가 관계와 정렬을 직접 추론해야 한다. 소규모 라이브러리에서는 문제가 없을 수 있지만, 패덤 프레임워크 같은 대규모 라이브러리에는 부족한 부분이 있을 수 있다.

Sphinx-js 플러그인은 파이선 패키지 인덱스에서 무료로 다운로드할 수 있다. Sphinx-js는 JSDoc의 지원 범위를 넘어 자바스크립트 문서화 도구에 대한 높은 수요로 탄생한 것이나 다름없다. editor@itworld.co.kr 


X