jsdoc prawidłowy typ parametru

Czy istnieje lista poprawnych typów znaczników parametrów dla jsdoc? Na przykład,jsdoc prawidłowy typ parametru

@param {type} myParam Some parameter description

wiem, że takie rzeczy jak number i String są ważne, ale co zrobić, jeśli chcę, aby udokumentować, że liczba jest liczbą całkowitą. Czy int jest prawidłowy?

Zrobiłem trochę googlowania, ale nie mogę znaleźć pełnej listy.

Źródło

2013-01-02 Jeff Storey

Oprzyrządowanie JS Dokumentacja, której użyłem, po prostu tokenizuje komentarze do ciągów, dzięki czemu można umieścić wszystko, co chcesz w sekcji {type}.

Można trzymać z typów JavaScript jeśli chcesz jak {numer}, lub jeśli chcesz określić można zrobić {liczba całkowita} ... I prawdopodobnie polecić coś takiego:

@param {Number} myParam must be an integer

Pozdro

Źródło

2013-01-03 00:28:59 hunterloftis

Zauważyłem, że narzędzia są zwykle tokenizacją ciągów, więc nie ma to znaczenia. Miałem tylko nadzieję, że istnieje jakiś standardowy zestaw typów. System typu javascript nie wydaje się wystarczająco ekspresyjny (np. Number is not very specific), ale istnieją opcje, jak pokazano powyżej. –

Można umieścić wszystko wewnątrz {}, ale może być miło wiedzieć, jakie są konwencje, nie? Czy naprawdę nie ma listy? Czy istnieje konwencja określająca obiekt Prototype, czy powinna to być @param {Object} ...? – fraxture

Dla generatora JSDoc (https://github.com/jsdoc3/jsdoc) w http://usejsdoc.org/tags-param.html jest powiedziane, "Typ parametru może być wbudowanym typem JavaScript, takim jak jako string lub Object lub JSDoc namepath do innego symbolu w twoim kodzie. " W przypadku symbolu w kodzie do jego definicji generowany jest link. Jednak wbudowane typy nadal wyświetlają się jako ciągi, więc nie ma żadnej różnicy np. między '{string}' i '{String}'. Ponadto np. PhpStorm rozpoznaje oba, ale narzeka na '{tablica}' akceptując '{Tablica}'. –

jsdoc prawidłowy typ parametru

Odpowiedz

Powiązane problemy