hand writing almost a thousand lines of documentation을 끝내고 다시는 그러지 않겠다고 다짐했다. 그래서 저는 이 지루한 작업을 수행할 수 있는 최고의 도구를 찾기 위해 탐구에 나섰습니다.

확실히 이러한 도구는 이미 존재해야 합니다. npm install 명령을 실행하면 완료됩니다. 아마...

기능적 JavaScript 코드를 문서화하려고 시도하고 있습니다. 이 코드는 예상보다 복잡해 보입니다. 기능적 자바스크립트가 등장하면서 이것이 너무 복잡하다는 사실에 놀랐습니다.

다음과 같은 문서를 만들고 싶습니다.

// how do I document you, little function?
const add = x => y => x + y

VSCODE의 intellisense가 문서를 이해하고 Markdown 파일이나 HTML을 생성하고 싶습니다.

JSDoc 3

분명한 첫 번째 시작은 JSDoc입니다. 나는 그들이 이 공간을 이끌고 있다고 믿는다. 그러나 문서에 관한 사이트의 경우 자체 문서는 정말 끔찍합니다. 내add 기능을 제대로 문서화하는 방법에 대한 정보를 찾지 못했습니다.

공개 문제Support for curried functions를 찾고 날짜를 확인합니다. 2016년 10월.



좋아... RIP JSDoc.

미나미

이것이 바로 내가 찾고 있는 것입니다. 스크린샷이 멋져 보이고... 어 오. JSDoc 3. 그리고 프로젝트는 2017년 4월 18일에 마지막으로 업데이트되었습니다.

RIP 미나미.

독스독스

이것은 견고해 보인다. 마지막 커밋 2018년 2월 19일. 아직 오랜 시간이지만 1년도 채 안 되었습니다.

그래서 나는 그들에게 손을 뻗는다How to document curried functions?.



라디오 침묵

RIP 독독스.

슬레이트

이것은 내가 가장 좋아하는 스크린 샷입니다. 리포지토리의 훌륭한 테마와 최근 활동.

하지만 어떻게 사용합니까? 언뜻 보면 사이트의 문서가 포괄적인 것처럼 보이지만 문서를 작성하려면 어떻게 해야 합니까?

제가 마크다운을 생성하고 그로부터 HTML이 생성되는 것 같습니다. 마크다운은 어디에 두어야 하나요? 마크다운의 이름은 무엇인가요? 문서용으로만 vagrant를 사용해야 하나요?

나는 이것을 버너 뒤에 놓을 것입니다.

hm-doc

What: Generates simple markdown documentation from Hindley-Milner single line // comments and optional /* */ block comments in JavaScript code.

흥미로운 것 같습니다. 커리 코드용 마크다운 생성기.

VSCODE는 많이 이해하지 못하지만 적어도 API 문서는 작성해야 합니다.

그래도 별 6개. 그래도 시도해 보겠습니다. 이미 문제를 제출했습니다.

선외 가작

ESDoc - JSDoc과 유사합니다.

YUIDoc - JSDoc과 유사합니다.

Autodoc - JavaScript 함수 바로 위의 주석에 테스트 작성

React Styleguidist - 리빙 스타일 가이드가 있는 격리된 React 구성 요소 개발 환경

Storybook - 대화형 UI 구성 요소 개발 및 테스트: React, React Native, Vue, Angular

다음은 무엇입니까?

솔직히 말해서, 나는 이러한 솔루션에 만족하지 않으며 내 솔루션을 롤링하는 데 이 정도 가깝습니다.

코드에 대한 문서를 생성하기 위해 어떤 솔루션을 사용합니까? 당신을 위해 어떻게 작동합니까?

내 기사는 매우 기능적인 JavaScript로 무겁습니다. 더 필요한 경우 여기 또는 Twitter에서 저를 팔로우하십시오!

더 많은 기사