JSDoc typedef在單獨的文件中

我可以在單獨的文件中定義所有自定義類型（例如types.jsdoc），以便它們可以在整個應用程序中重用？什麼是正確的做法？JSDoc typedef在單獨的文件中

/** 
* 2d coordinates. 
* @typedef {Object} Coordinates 
* @property {Number} x - Coordinate x. 
* @property {Number} y - Coordinate y. 
*/

是的，你可以。您可能需要在定義中添加'@ global'，或者嘗試JSDoc中命名空間的不同方法（混淆，恕我直言，爲了我自己的目的，只有WebStorm inlineinfo/help和HTML API文檔運行良好）。 –

我通常在我的項目類似，區別在於我使用擴展.js來命名文件。 Webstorm完美工作，並能夠檢查類型和自動完成就好。它不會識別.jsdoc擴展名（我剛剛檢查過），因此即使該文件不包含任何代碼語句，也要堅持使用.js。

2017-10-01 20:40:38

回答