什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護 ...
js注釋規范基於jsdoc,寫出的代碼注釋能夠成功生成注釋文檔。 參數和返回值類型Type:string boolean number object array function 文件注釋 在文件頭部增加文件注釋 變量注釋 將關鍵的變量進行特殊注釋,生成到文檔中 常量注釋 將關鍵常量進行特殊注釋,生成到文檔中,如果有默認值增加 default屬性 方法注釋 基本方法塊注釋 如果描述不能描述清楚,添 ...
2019-01-02 11:20 1 1440 推薦指數:
什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護 ...
命令名描述@param @argument 指定參數名和說明來描述一個函數參數@returns 描述函數的返回值@author 指示代碼的作者@deprecated 指示一個函數已經廢棄,而且在將來的 ...
什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護成本,和提高 ...
命令名描述 @param @argument 指定參數名和說明來描述一個函數參數@returns 描述函數的返回值@author 指示代碼的作者@deprecated 指示一個函數已經廢棄,而 ...
官方文檔 http://usejsdoc.org/ - sublime插件 https://github.com/spadgos/sublime-jsdocs - 生成文檔 生成html: (1)安裝:npm install jsdoc -g (2)執行:jsdoc test.js ...
使用JSDoc /**基礎類型*/ /** @type {string} */ /**聯合類型 */ /** @type {string | number ...
1.JSDoc安裝和配置: JSDoc安裝:使用npm安裝npm install jsdoc –g JSDoc配置:進入JSDoc的安裝目錄找到並修改 conf.json.EXAMPLE進行自定義配置,也可以不做修改使用默認配置 2.JSDoc注釋文檔編輯: 格式 ...
jsDoc 說白了就是幫助你生成JS的文檔,但有個前提,就是你編寫的JS代碼中,需要按一定的格式寫注釋后,這個工具軟件才能幫你正確的生成文檔! 一、配置使用環境。此軟件是 JAVA寫的,所以我們要在windows 系統中配置java的環境變量 1、下載jdk(http ...