什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護 ...
命令名描述 param argument 指定參數名和說明來描述一個函數參數 returns 描述函數的返回值 author 指示代碼的作者 deprecated 指示一個函數已經廢棄,而且在將來的代碼版本中將徹底刪除。要避免使用這段代碼 see 創建一個HTML鏈接,指向指定類的描述 version 指定發布版本 requires 創建一個HTML鏈接,指向這個類所需的指定類 throws ex ...
2018-05-25 17:14 0 8931 推薦指數:
什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護 ...
命令名描述@param @argument 指定參數名和說明來描述一個函數參數@returns 描述函數的返回值@author 指示代碼的作者@deprecated 指示一個函數已經廢棄,而且在將來的 ...
什么是 JSDoc JSDoc 是一個根據 JavaScript 文件中注釋信息,生成 JavaScript 應用程序或模塊的API文檔的工具。你可以使用 JSDoc 標記如:命名空間,類,方法,方法參數等。從而使開發者能夠輕易地閱讀代碼,掌握代碼定義的類和其屬性和方法,從而降低維護成本,和提高 ...
js注釋規范基於jsdoc,寫出的代碼注釋能夠成功生成注釋文檔。 參數和返回值類型Type:string、boolean、number、object、array、function 文件注釋 在文件頭部增加文件注釋 變量注釋 將關鍵的變量進行特殊注釋,生成到文檔中 ...
官方文檔 http://usejsdoc.org/ - sublime插件 https://github.com/spadgos/sublime-jsdocs - 生成文檔 生成html: (1)安裝:npm install jsdoc -g (2)執行:jsdoc test.js ...
@import url(http://www.cnblogs.com/Load.ashx?type=style&file=SyntaxHighlighter.css); @import url(/css/cuteeditor.css); 1. 注釋宏或者常量 ...
1 規范目的 一個軟件的生命周期中,80%的花費在於維護; 幾乎沒有任何一個軟件,在其整個生命周期中,均由最初的開發人員來維護; 編碼規范可以改善軟件的可讀性,可以讓程序員盡快而徹底地理解新的代碼。為了執行規范,每個軟件開發人員必須一致遵守編碼規范; 使用統一編碼規范 ...