Ich habe eine JavaScript-Funktion, die einige Parameter einschließlich Objekttypen enthält. Eine Eigenschaft eines Parameters, die ein Objekt ist, wird jedoch als veraltet verwendet. Ich möchte diese Situation in der Dokumentation angeben, aber ich weiß nicht, wie @param-Tag mit @deprecated verwendet wird. Betrachten Sie das Beispiel unten:
%Vor%Ich möchte die Eigenschaft "type" des Objekts "options" verwerfen. Wie kann ich das tun, oder kann ich?
Offizielle JSDoc-Dokumentation zeigt nicht an, dass das @deprecated -Tag dazu verwendet werden kann, etwas anderes als ein ganzes Symbol abzulehnen .
Das @deprecated -Tag kann verwendet werden, um zu dokumentieren, dass zum Beispiel eine Funktion als Ganzes veraltet ist.
Sie können natürlich, wie @Droogans in den Kommentaren sagt, etwas wie deprecated: vor der @param description einfügen. Wenn ein Entwickler das veraltete Feature immer noch verwendet, könnten Sie eine Warnung von einigen Arten implementieren.
Tags und Links javascript jsdoc deprecated param