Ich habe eine Funktion, die einen Zeichenfolge-Parameter akzeptiert. Dieser Parameter kann nur einen von wenigen definierten möglichen Werten haben. Was ist der beste Weg, um dasselbe zu dokumentieren? Sollte shapeType als enum oder TypeDef oder etwas anderes definiert werden?

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;
};

Der zweite Teil des Problems ist, dass die möglichen Werte vonshapeType ist in der Datei, die definiert, nicht bekanntshapeType als was auch immer Sie vorschlagen. Es gibt mehrere Dateien, die von mehreren Entwicklern zur Verfügung gestellt wurden, um die möglichen Werte von zu erhöhenshapeType.

PS: Benutzejsdoc3