(jsduck/jsdoc) cucumber.js 단계 정의를 어떻게 문서화 하시겠습니까?

Question

cucumber.js 단계 정의 코드의 단계를 문서화하는 방법이 있습니까?

/** 
* @class Global.steps.common 
* Common steps. 
*/ 
var steps = module.exports = function() { 
    /** 
    * Step 1 description. 
    */ 
    this.Given(/^StepDef1$/, function(next) { 
     ... 
    }); 

    /** 
    * Step 2 description. 
    */ 
    this.Given(/^StepDef2$/, function(next) { 
     ... 
    }); 
}); 

을하지만 jsduck는 마지막 한 단계 설명을 인식 나는 jsduck의 @class 그것을 모방하려고 노력했습니다.

Answer 1

주요 문제는 단계 이름입니다. Cucumber를 사용하면 /Given I have entered (.*) into the calculator/과 같은 평범한 텍스트를 상당히 오래 사용하고 싶을 것입니다. 문서 도구는 주로 addNumber과 같은 다양한 식별자를 문서화 할 것을 기대합니다 (JSDoc에 대해서는 그렇게 확신하지 않지만 JSDuck은 클래스에 허용되는 문자에 제한이 있습니다 속성 이름). jsduck는, 마지막 단계을 인식 JSDuck이 문서 블록이 설명하는 항목의 이름을 자동으로 감지하려고한다는 사실에서 비롯된 것으로

구체적인 문제는, Given으로 모두에게이를 감지하고 같은 것입니다 그것 동일한 이름의 여러 속성을 허용하지 않습니다. 마지막 속성 만 마지막 출력에 렌더링됩니다.

/** 
* @property Given_I_have_entered_X_into_the_calculator 
* Step 1 description. 
*/ 
this.Given(/^Given I have entered (.*) into the calculator$/, function(next) { 
    ... 
}); 

물론 상당히 지루한 :

그래서, 당신이 할 수있는 당신의 속성이 같은 이름을 부여합니다. 당신은 extending JSDuck with your own custom tags하여 해당에 향상시킬 수 있습니다, 그래서 당신은 쓸 수 있습니다 : 당신이 쉽게 코드에서 정규 표현식에서 이름을 자동으로 감지 할 수 있도록

/** 
* @Given I have entered ? into the calculator 
* Step 1 description. 
*/ 
this.Given(/^Given I have entered (.*) into the calculator$/, function(next) { 
    ... 
}); 

불행하게도 JSDuck의 사용자 정의 태그 시스템이 제한됩니다. 아마도 JSDuck을 포크하고 내부를 확장 할 수 있습니다.