W JSDoc, najlepsza dokumentacja, jaką mogę znaleźć, pokazuje użycie następującego, jeśli masz tablicę określonego typu (na przykład tablicę ciągów), taką jak:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
Jak zamienić poniższe znaki zapytania na tablicę obiektów?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
javascript
documentation
jsdoc
Promień
źródło
źródło
Odpowiedzi:
Powinieneś bardziej szczegółowo określić, co masz na myśli, mówiąc o JSDoc - jest to ogólny termin obejmujący prawie wszystkie narzędzia dokumentacji JavaScript w stylu JavaDoc.
Składnia, której użyłeś dla tablicy ciągów, wygląda jak obsługiwana przez Google Closure Compiler .
Używając tego, tablica obiektów wyglądałaby następująco:
Lub po prostu tablica czegokolwiek - to powinno działać z prawie wszystkimi narzędziami do dokumentacji:
jsdoc-toolkit , JSDoc 3 i JSDuck obsługują następującą składnię do oznaczania tablicy obiektów:
EDYTOWAĆ
Jeśli znasz klucze i typ zmiennej wartości, możesz również zrobić:
lub
źródło
{Array<Object>}
. Tylko po to, aby ten post był aktualny.Array.<string[]>