使用YUIDoc生成JS文檔

其實YUIDoc主頁已經寫的比較清晰了，但有一些概念和細節再點出一些注意的地方。 目前最新的YUIDoc使用nodejs進行開發安裝和使用都很是的方便。 咱們只須要將咱們的代碼加上必要的註釋，即可以很方便的生成文檔。

前提

1. 已經安裝了nodejs
2. 已經安裝了npm

安裝

使用npm安裝yuidoc

npm -g i yuidocjs

生成

一次性生成

yuidoc .

一次性生成該目錄及其子目錄下全部JS的文檔 默認在不配置的狀況下會生成在當前目錄的out目錄中

實時生成

YUIDoc還提供了一種實時文檔生成的方式，有利於團隊協做開發 好比在SVN上部署YUIDoc實時文檔，遞交到SVN的代碼都會及時生成文檔提供團隊使用查閱

yuidoc --server

默認開放監聽當前目錄文件變更，開放3000端口 能夠經過

http://127.0.0.1:3000/

來訪問文檔 若是3000端口被佔用，也能夠指定特定端口號

yuidoc --server 5000

來經過開放5000端口提供文檔訪問

註釋

模塊與類註釋

YUIDoc中代碼是分模塊的 一個模塊中包含着與這個模塊相關的類文件 而模塊的定義都是混在每一個類文件中的 好比ClassA類屬於core模塊 能夠這麼加註釋

/**
 * @module core
 */

/**
 * blablabla
 * @class ClassA
 * @constructor
 */
function ClassA() {}

方法註釋

ClassA有個方法爲init能夠這麼寫

/**
 * blablabla
 * @method init
 * @param config {Object} 
 * @param config.containerId {String} desc
 * @param config.bgImageUrl {String} desc
 * @param config.bInstance {ClassB} 若是ClassB也在註釋中，生成後的文檔會自動加link
 * @public
 */

這裏的param定義了該方法有一個參數config 而該參數中會被用到的屬性和類型也做出明確註釋 yuidoc會自動生成改config層級關係

注意點

若是一個文件中不註明它屬於哪一個模塊，那麼該文件會被忽略 不寫@class的整個類都會被忽略 不寫@method的那麼這個方法在文檔中是找不到的 yuidoc並不會去找你代碼中的方法名 它只關心文檔中的這幾個關鍵的註釋，至於註釋的位置與代碼是否真實存在都是沒有關係的 徹底能夠是一個空文件，裏面沒有代碼，定義一堆註釋，yuidoc照樣解析不誤，因此註釋的位置是沒有關係的

沒有提到的

更多配置

想要更多配置項的能夠關注下 Running YUIDoc on the Command Line Configuring YUIDoc with yuidoc.json

更換主題

YUIDoc Themes

引用

• YUIDoc
• YUIDoc Syntax Reference