Javascript文檔產生

來源:互聯網
上載者:User
Javascript文檔產生是比較頭疼的問題,不過現在已經有開源的工具可以使用——JsDoc。
其官方網站地址:http://jsdoc.sourceforge.net/
Release版的是:http://sourceforge.net/projects/jsdoc
JsDoc是根據Javascript代碼中的注釋產生相應的協助文檔,它定義了一套注釋標籤規範。因此在編寫Javascript代碼時,要根據它能識別的注釋標籤進行注釋。
具體使用方法如下:
1、如果作業系統是windows的使用者,需要配置perl環境,推薦安裝ActivePerl ,Linux/Unix使用者則不用配置了。
2、解壓縮JsDoc,在命令提示視窗中進入JsDoc所在目錄,使用如下命令即可產生Javascript代碼的文檔。
                                 perl jsdoc.pl test.js
其中test.js是用於測試的js檔案,如果成功則在該目錄下產生js_docs_out目錄,裡麵包含產生的文檔。
3、如果產生失敗,產生如下錯誤資訊:
                                 Can't locate HTML/Template.pm in @INC ......
需要配置HTML::Template模組,配置方法為:
進入perl的Package Manager,可以使用命令ppm,也可以點擊開始菜單——ActivePerl 5.8.8 Build 817——Perl Package Manager。然後使用install命令安裝HTML::Template模組,代碼如下:
                                 C:\> ppm
                                 PPM> install HTML-Template
                                 PPM> quit

具體的參數及用法可以查看JsDoc的官方網站。

        

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.