當前位置:
首頁 >
前端技术
> javascript
>内容正文
javascript
JSDoc的使用
2019獨角獸企業重金招聘Python工程師標準>>>
1、簡單介紹
????????JSDoc是一個根據javascript文件中注釋信息,生成JavaScript應用程序或庫、模塊的API文檔 的工具。你可以使用他記錄如:命名空間,類,方法,方法參數等。類似JavaDoc和PHPDoc?,F在很多編輯器或IDE中還可以通過JSDoc直接或使用插件生成智能提示。從而使開發者很容易了解整個類和其中的屬性和方法,并且快速知道如何使用,從而提高開發效率,降低維護成本。
2、作用
(1)、生成api文檔
(2)、生成智能提示
3、官方文檔
gitbook文檔:http://www.css88.com/doc/jsdoc/index.html
html5+聯盟:http://www.html5plus.org/doc/jsdocp.html#type_syntax
4、生成文檔
https://github.com/jsdoc3/jsdoc
npm install jsdoc -gjsdoc yourJavaScriptFile.js?
?
?
?
?
?
?
轉載于:https://my.oschina.net/u/1416844/blog/849986
總結
- 上一篇: SpringMVC+Mybatis+My
- 下一篇: 【心灵鸡汤】高情商者的15个表现