Como documentar um tipo de string no jsdoc com valores limitados
Eu estou tendo uma função que aceita um parâmetro de seqüência de caracteres. Esse parâmetro pode ter apenas um dos poucos valores possíveis definidos. Qual é a melhor maneira de documentar o mesmo? O shapeType deve ser definido como enum ou TypeDef ou algo mais?
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;
};
A segunda parte do problema é que os possíveis valores deshapeType
não é conhecido no arquivo que defineshapeType
como o que você sugere. Existem vários arquivos contribuídos por vários desenvolvedores que podem adicionar aos valores possíveis deshapeType
.
PS: estou usandojsdoc3