JsDoc – vlastnosti položek pole objektů

2. 5. 2012 19:33:02

Zdravím. Nevíte někdo, jak v JsDoc dokumentovat vlastnosti objektů v poli předávaném jako parametr funkce? Nemůžu k tomu nic najít, ale připadá mi divný, že by chyběla možnost dokumentovat takovouhle celkem běžnou konstrukci:

Předem díky za odpovědi.

2. 5. 2012 19:33:02

https://webtrh.cz/diskuse/jsdoc-vlastnosti-polozek-pole-objektu/#reply761086

Martin Schlemmer

(36 hodnocení)

2. 5. 2012 23:19:25

V tomto konkrétním případě co definovat základní typ, který se v parametru opakuje (nazval jsem ho cell), a v JsDocu zadat pole typů cell[]:

Pro pojmenované properties kopíruju příklad z dokumentace

http://code.google.com/p/jsdoc-toolkit/wiki/TagParam

2. 5. 2012 23:19:25

https://webtrh.cz/diskuse/jsdoc-vlastnosti-polozek-pole-objektu/#reply761085

800XE

(8 hodnocení)

2. 5. 2012 23:29:58

Díky za zajímavý workaround. Jen je mi trochu proti srsti kvůli dokumentaci definovat novou třídu, když zároveň prvky pole ve skutečnosti nebudou její instance. Ale nic lepšího jsem nikde nenašel, takže to udělám takhle. Díky za tip!

2. 5. 2012 23:29:58

https://webtrh.cz/diskuse/jsdoc-vlastnosti-polozek-pole-objektu/#reply761084

Pro odpověď se přihlašte.

Přihlásit