mobile menu

The Arrow Newsletter

mobile menu

jsdoc 예제

코드 베이스에 예제를 포함하려면 @example 태그 사용: 간단한 예제에서 함수가 필요한 매개 변수의 형식을 간단하고 빠르게 이해할 수 있습니다. 함수 내부를 들여다보면 안 됩니다. 더 자주 함수, 메서드는 더 복잡 하 고 함수에 점프 하 고 매개 변수의 형식을 참조 하는 데 시간이 걸립니다. 자바스크립트를 문서화하기 위해 Javadoc과 같은 구문을 사용하는 최초의 예[인용 필요]는 1999년에 자바스크립트로 작성된 자바스크립트 런타임 시스템인 넷스케이프/모질라 프로젝트 Rhino와 함께 출시되었습니다. [1] 그래서이 예에서 무슨 일이 일어나고 있는가? 글쎄, 우리는 먼저 우리가 /**로 코멘트를 시작하여 특별한 JSDoc 코멘트를 작성하려고한다는 것을 의미합니다. 하나의 별으로 시작하거나 세 번째 별을 추가하면 JSDoc이 주석을 완전히 무시하라고 알려주므로 별 의 수에주의를 기울이십시오! 함수, 클래스 또는 생성기를 정의하는 데 사용되는 주석 블록 내에서 @example 태그를 사용합니다. 우리 모두는 (희망) 좋은 문서 및 참조 자료가 성공적인 소프트웨어 프로젝트에 얼마나 중요한지 알고있다. 좋은 문서가 없으면 특정 라이브러리를 사용할 수 없습니다. 서로 다른 구성 요소와 메서드가 격리되어 작동하는 방식에 대한 참조없이 프로젝트의 모든 다른 조각이 서로 어떻게 조화를 이리저리 맞추는지에 대한 예는 물론, 우리는 단지 원본을 읽는 것만으로 저자의 원래 의도를 해석할 수 있습니다. 소스 코드, 또는 우리가 운이 좋은 경우, StackOverflow에 도달 하 고 임의의 오류 메시지를 검색. 이 사내 또는 작은 프로젝트인 경우, 당신은 아마 완전히 나사로 조입니다.

카피 파스타 블랙 매직 부두 접근 방식을 입력하고 모든 것이 의도 한대로 작동 희망! 이것은 실제로 어떻게 생겼습니까? 다음은 짧은 예입니다: 문서.js의 흐름 통합을 사용하면 원래 예제를 이것으로 변경할 수 있습니다. 예를 들어 Stripe의 API 설명서는 깨끗하고 보기 쉬울 뿐만 아니라 탐색하기 쉬우며 개발자 API와 제대로 상호 작용하는 방법에 대한 8개의 개별 언어로 된 예제와 함께 완전히 추가됩니다. 새 고객을 만드는 방법을 알고 싶으십니까? 확실! 코드를 작성하시겠습니까? JSDoc은 주석 내의 관계를 추적하기 위해 @ 기호로 미리 정렬된 태그를 활용합니다. 예를 들어 다음과 같은 함수를 설명할 수 있습니다. 여기서 recurse는 true로 설정되어 있으므로 폴더를 추가하면 확장 “.js” 또는 “.jsdoc”이 있는 폴더 내의 모든 파일이 추가됩니다. 변수는 JSDoc을 사용하여 문서화할 수 있습니다. 예를 들어, 좀 더 복잡한 예제를 사용하면 약간 더 좋아질 수 있지만 일반적으로 코드를 문서화할 때 수행해야 할 작업만큼이나 많은 작업이 가능합니다. 작업을 더 수행하여 @example 추가하여 이 코드를 사용하는 방법에 대한 컨텍스트를 더 많이 제공할 수 있습니다. 그러나 하루가 끝나면 코드 베이스를 문서화하는 동안 필요한 한입니다.