幾天工作上需要文檔化一些Javascript東西，所以在找一些JS文檔化工具，以下分析幾種工具。

1.JSDoc-toolkit

? 一開始還想用這個工具，但后來在解析生成文檔時候，出現(xiàn)了很嚴(yán)重的錯誤，還存在其他問題。

? ? 問題1：閉包存在時候，解析出錯(很嚴(yán)重) ，導(dǎo)致幾乎就不能用來做JS文檔化。

? ? 問題2：在Javascript部分，注釋怎么寫都不對，感覺這個工具使用起來很困難

? ? 問題3：如果是靜態(tài)函數(shù)或prototype設(shè)置函數(shù)，就會出問題，warning錯誤，然后生成的文檔很怪異

? 之所以會出現(xiàn)上面種種問題，關(guān)鍵點就是解析時需源代碼，這問題太嚴(yán)重了。

? 也是解析出錯這個原因，導(dǎo)致最后不得不舍棄這個工具。

? ? 建議：JavaDoc可以用，感覺這種工具更多是給Java用的

2.JSDoc

? 很類似JSDoc-toolkit ，注釋方式幾乎一樣，沒什么差別，同樣解析需源代碼（又不得不舍棄）。

? PS:因為不同的人寫js的方式千奇百怪，不能強制js的寫法，最好是只需要規(guī)范注釋寫法，文檔生成工具從注釋獲取信息來生成文檔。

3.YUIDoc

? 只解析YUIdoc的注釋塊，不解析源代碼(令人振奮的消息，可以支持多種語言,產(chǎn)生錯誤 的可能將大大減小)，只需要安裝nodejs，在命令行安裝YUIDoc就可用了，使用起來也非常簡單。但是，這個工具還是基于面向?qū)ο笳Z言來做文檔化的，所以在給JS使用時，還是有些怪異，不過這些問題是可以忍受的。

?

總之，一個好的文檔化工具，最好是有兩鐘模板，一個給函數(shù)式語言使用，一種給面向?qū)ο笳Z言使用，兩者雜糅起來挺不好的。另外最好是簡單易用，特別不要出現(xiàn)解析出錯，一出現(xiàn)解析出錯，相信再好用再華麗也沒有人用。

?

轉(zhuǎn)載于:https://www.cnblogs.com/lovesong/p/3267047.html

總結(jié)

以上是生活随笔為你收集整理的JSDoc那些事的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。