使用YUIDoc生成JS文件

其實yuidoc主頁已經寫的比較清晰了，但有一些概念和細節再點出一些注意的地方。目前最新的yuidoc使用nodejs進行開發安裝和使用都非常的方便。我們只需要將我們的**加上必要的注釋，便可以很方便的生成文件。

前提

已經安裝了nodejs

已經安裝了npm

安裝使用npm安裝yuidoc

npm -g i yuidocjs

生成

一次性生成

yuidoc .

一次性生成該目錄及其子目錄下所有js的文件預設在不配置的情況下會生成在當前目錄的out目錄中

實時生成

yuidoc還提供了一種實時文件生成的方式，有利於團隊協作開發比如在svn上部署yuidoc實時文件，遞交到svn的**都會及時生成文件提供團隊使用查閱

yuidoc --server

預設開放監聽當前目錄檔案變動，開放3000埠可以通過

來訪問文件如果3000埠被占用，也可以指定特定埠號

yuidoc --server 5000

來通過開放5000埠提供文件訪問

注釋模組與類注釋

yuidoc中**是分模組的乙個模組中包含著與這個模組相關的類檔案而模組的定義都是混在每個類檔案中的比如classa類屬於core模組可以這麼加注釋

/**
* @module core
*//**
* blablabla
* @class classa
* @constructor
*/function classa() {}

方法注釋

classa有個方法為init可以這麼寫

/** * blablabla * @method init * @param config * @param config.containerid desc * @param config.bgimageurl desc * @param config.binstance 如果classb也在注釋中，生成後的文件會自動加link * @public

*/

這裡的param定義了該方法有乙個引數config 而該引數中會被用到的屬性和型別也作出明確注釋 yuidoc會自動生成改config層級關係

注意點如果乙個檔案中不註明它屬於哪個模組，那麼該檔案會被忽略不寫@class的整個類都會被忽略不寫@method的那麼這個方法在文件中是找不到的 yuidoc並不會去找你**中的方法名它只關心文件中的這幾個關鍵的注釋，至於注釋的位置與**是否真實存在都是沒有關係的完全可以是乙個空檔案，裡面沒有**，定義一堆注釋，yuidoc照樣解析不誤，所以注釋的位置是沒有關係的

沒有提到的

更多配置

configuring yuidoc with yuidoc.json

更換主題

yuidoc themes

引用

使用YUIDoc生成JS文件

關於jsdoc3,yuidoc使用感受

使用iText生成pdf文件

使用itext生成word文件

使用YUIDoc生成JS文件

關於jsdoc3,yuidoc使用感受

使用iText生成pdf文件

使用itext生成word文件

相關推薦