jsdoc

7열

3답변

나는 작업중인 lib에 대한 문서 생성을 처리하기 위해 documentationjs (jsdoc를 사용)을 사용하고 있습니다. 내 라이브러리는 ES6이며 완전한 기능을 제공하며 현재 생성 된 문서는 lib의 모든 모듈에있는 모든 함수의 알파벳 순 목록입니다. 이것은 당신이 찾고있는 것을 찾는 것을 매우 어렵게 만듭니다. 한 파일의 함수가 문서에서 함께 그룹

0열

1답변

로컬로 정의되지 않은 JSDoc에서 함수를 문서화 할 수 있습니까?

내 코드에서 두 번있는 기본 패턴은 exports.thing = thingFromSomewhereElse이고, 나는 자신을 정의한 것처럼 thingFromSomewhereElse의 기능 멤버를 문서화하려고합니다. 하지만 실제로는 thing.functionName = function() {...} 없이는 어떻게되는지 알 수 없습니다. @callback 태그를

0열

1답변

JSDoc - 함수를 다른 함수의 속성으로 할당하는 방법

jsdoc을 실행할 때 출력에 foo.bar 속성에 대한 내용이 표시되지 않습니다. /** * Foo */ const foo = function foo() { //... } /** * Bar */ foo.bar = function bar() { //... } 가 어떻게 foo의 속성 것으로 bar를 표시 할 수 있습니

0열

2답변

이 ESLint/JSDoc 구문 오류를 수정하는 방법은 무엇입니까?

나는이 기능을 문서화 한 ... /** * Perform an asynchronous HTTP (Ajax) request. * * @param {String|Object} url A string containing the URL to which the request is sent, or the settings object. * @param {Obje

0열

1답변

jsdoc 모든 밑줄 메소드를 개인용으로 설정하십시오.

jsdoc을 사용하여 커다란 코드베이스를 가지고 있습니다. 우리는 많은 사적인 방법들이 @private 플래그를 가지고 있지 않다는 것을 알아 차렸다. 설정을 개인용으로 밑줄로 시작하는 모든 메소드를 볼 수 있습니까? 난 정말 손으로 그것을 할 수백 파일을 통해 가야하는 것을 피하기 위해 싶습니다.

0열

1답변

JSDoc을 소스 라인에 연결할 수 있습니까?

jsdoc을 파일의 시작 부분이 아닌 소스 코드 파일의 행에 직접 링크 할 수있는 방법이 있습니까?

2열

1답변

jsdoc에서 @param을 사용하는 방법

이것이 바보 같은 질문이지만 jsdoc으로 작업하기 시작했고 doc 파일을 생성하는 데 문제가 있습니다. 필자가 온라인에서 발견 한 몇 가지 예제를 모두 따라했는데, 모두 본질적으로 같지만 어떤 이유로 내가 문서화하려는 변수 중 하나에 대한 설명서를 생성 할 수 없습니다. 이것은 내 코드입니다. /** *@fileOverview mainController

1열

1답변

VSCode JSDoc Intellisense 용 다중 행

내 설명서에서 JSON 예제를 찾고 있는데, 이는 내 Intellisense에서 VScode에 대한 JSON 예제를 갖게됩니다. 제가 생각할 수있는 책에서 모든 트릭을 시도했습니다. JSON을 읽을 수있게 해주는 줄 바꿈과 관련이 있습니다. 이 작업을 VScode에서 사용할 수는 없지만, 화이트 스페이스를 가져 와서 한 줄을 만듭니다. 내가 수행하려고 :과

0열

1답변

Visual Studio 코드의 Intellisense로 함수 설명서를 어떻게 봅니까?

Mac에서 Visual Studio 코드로 Javascript를 작성하고 있습니다. 내가 JSDoc 형식으로 문서화 된이 기능이 있습니다 그러나 /** * Adds the passed Matter Body to the simulation. * @param {Matter.Body} body - The body to add to the physics sim

2열

1답변

JSDoc에서 고유 한 클래스 유형을 올바르게 정의하는 방법은 무엇입니까?

저는 간단한 ES6 클래스를 가지고 있으며이를 JSDoc에서 올바르게 설명하는 방법을 알고 싶습니다. 내 자신의 유형을 정의하고 싶습니다. 나중에 WebStorm 자동 완성으로 인식됩니다. 아래의 예는 유효합니까? /** * @typedef {Object} View * @class */ class View{...}