jsdoc-toolkit進階使用

來源:互聯網
上載者:User

jsdoc-toolkit基本使用網上一大摞,就不盜取別人的了,分享幾個我沒搜到的幾個進階使用:

 

1.  如何指定產生文檔的指令檔列表,例如一個指令碼庫裡有很多檔案,只想給一部分產生doc,命令列沒有相關的參數,可以使用設定檔,參數"_"是源檔案清單。

{<br />// source files to use ,'src-new/util/util.js'<br />_: ['src/base/base.js',<br /> 'src/ui/Mask.js',<br /> 'src/ui/Editor.js'<br /> ],</p><p>// document all functions, even uncommented ones<br />a: true,</p><p>// including those marked @private<br />//p: true,</p><p>// some extra variables I want to include<br />D: {generatedBy: "jianjun.wang", copyright: "2008"},</p><p>// use this directory as the output directory<br />d: "doc",</p><p>// use this template<br />t: "lib/jsdoc-toolkit/templates/jsdoc"<br />}

 

 

2.  如何為協助插入外部連結

 

@link <a target="_blank" href="../../src/ui/aaa/example.html">例子</a>

 

jsdoc-toolkit地址: http://code.google.com/p/jsdoc-toolkit/

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在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.