Jak udokumentować typ ciągu w jsdoc z ograniczonymi możliwymi wartościami
Mam funkcję, która akceptuje jeden parametr string. Ten parametr może mieć tylko jedną z kilku zdefiniowanych możliwych wartości. Jaki jest najlepszy sposób dokumentowania tego samego? Czy shapeType powinien być zdefiniowany jako enum lub TypeDef lub coś innego?
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;
};
Druga część problemu polega na tym, że możliwe wartościshapeType
nie jest znany w pliku, który definiujeshapeType
jak cokolwiek sugerujesz. Istnieje kilka plików dostarczonych przez kilku programistów, którzy mogą dodać do możliwych wartościshapeType
.
PS: Używamjsdoc3