하나의 문자열 매개 변수를 받아들이는 함수가 있습니다. 이 매개 변수는 정의 된 몇 가지 가능한 값 중 하나만 가질 수 있습니다. 이를 문서화하는 가장 좋은 방법은 무엇입니까? shapeType을 enum 또는 TypeDef 또는 다른 것으로 정의해야합니까?
Shape.prototype.create = function (shapeType) {
// shapeType can be "rect", "circle" or "ellipse"...
this.type = shapeType;
};
Shape.prototype.getType = function (shapeType) {
// shapeType can be "rect", "circle" or "ellipse"...
return this.type;
};
문제의 두 번째 부분은의 가능한 값이 사용자가 제안한대로 shapeType
정의하는 파일에서 알 수 없다는 shapeType
것입니다. 의 가능한 값을 추가 할 수있는 여러 개발자가 제공 한 여러 파일이 있습니다 shapeType
.
PS : 사용 중 jsdoc3
enum
함수 매개 변수에 대한 정의와 공용체를ShapeType|string
봅니다. 그러나 열거 형은 Closure-compiler에서 선언 후 하위 유형 추가를 지원하지 않습니다.