우리는 reactjs 응용 프로그램에서 정의한 각 구성 요소 의 doc 파일을 생성해야한다는 요구 사항이 있습니다. 이 확장의 문서를 만드는 데 사용할 수있는 npm을 찾고 있으므로 코드를 작성하고 내 구성 요소의 모든 것을 주석 처리하고 을 확장 문건으로 변경하십시오. 어떻게 도와 드릴까요? 내 질문은 jsdoc과 관련된 다른 질문과 다르다. jsdoc을 사용하여 reactjs에서 문서를 찾고 있기 때문이다.ReactJS에서 문서화하는 방법?
마지막으로 내가 솔루션, 우선은이 링크에 가서 제대로 문서를 읽을 발견 : - Read Document 이제 다음 단계를 수행합니다 -
사용의
전 세계에 물건을 설치하는 것을 피하는 것이 좋습니다. 대신'npm install jsdoc --save-dev'를 사용하여 프로젝트에 설치 만 할 수 있습니다. 그런 다음 doc을 만들기위한 npm 스크립트를 추가하십시오. 예를 들어,''createdoc '': "jsdoc src -r -d docs"'그러면'npm run createdoc'으로 실행할 수 있습니다. – Oskar
이 패키지를 사용해보십시오. 이해할 수있는 예제가 있습니다.
React.createClass, ES2015 클래스 정의 또는 함수 (stateless 구성 요소)를 통해 정의 된 React 구성 요소의 기본 구현을 제공합니다. 이러한 구성 요소 정의는 분석 가능하도록 특정 지침을 따라야합니다 (자세한 내용은 아래 참조).
우리는 React Styleguidist를 사용하여 우리의 반작용 구성 요소 라이브러리를 문서화합니다.
은 다음과 같은 기능 코드를 구문 분석 :
Webpack을 통해 웹 응용 프로그램을 빌드하여 작동합니다. 로컬로 사용하거나 모든 개발자를 위해 호스팅 할 수 있습니다.
우리에게는 꽤 효과적이며 시간이 지남에 따라 개선됩니다.
편집 : 사용중인 react-docgen입니다.
우리는 많이있다. 큰 장점 - 이미 구성된 웹팩, 바벨, 린트 등으로 2 분 안에 새로운 프로젝트를 시작할 수 있습니다.
매우 좋습니다.
나는 반응 -docgen을위한 작은 래퍼를 작성 했으므로 작업을 조금 더 간단하게 만들 수 있습니다. 전달 된 폴더의 모든 구성 요소에 대한 마크 다운 파일을 내 보냅니다.
체크 아웃 프로젝트 여기 의도에 대한 호기심 https://github.com/LaustAxelsen/wilster-doc
여기에 코드를 게시 할 수 있습니까? – Intervalia
: 당신의 목표는 유용한 문서를 가지고 또는 구성 요소가 공식적으로 문서화 할 때 당신의 목표를 달성입니까? –
당신은 이것을 요구하고 있습니까? https://www.npmjs.com/package/jsdoc 라이브러리 또는 도구에 대한 요청은 offtopic입니다. –
[JSDoc에 HTML을 생성하는 방법] 가능한 복제본 (http://stackoverflow.com/questions/35182918/how-generate- html-for-jsdoc) –