編輯“Ajax- 使用JSDoc建立JavaScript代碼的文檔”（章節(jié)）

== 使用JSDoc建立JavaScript代碼的文檔 ==


像其他的許多編程語(yǔ)言一樣，在一般的軟件開(kāi)發(fā)人員看來(lái)，JavaScript也有一個(gè)基本的缺陷：編寫(xiě)（或者重新編寫(xiě)）一個(gè)功能通常相對(duì)容易，但是要閱讀現(xiàn)有的代碼并明確它是如何工作的，就不那么輕松了。編寫(xiě)代碼時(shí)可以適當(dāng)?shù)卦黾幼⑨?，這樣當(dāng)其他開(kāi)發(fā)人員要理解代碼如何工作，特別是要修改代碼的功能時(shí)，就能減輕他們的負(fù)擔(dān)，節(jié)省他們的時(shí)間和精力。<br>

Java語(yǔ)言引入了一個(gè)工具，名為javadoc。這個(gè)工具可以根據(jù)源代碼中的文檔注釋以HTML格式生成API文檔。所生成的HTML文檔在任何Web瀏覽器上都能閱讀，而且由于它是以HTML格式生成的，所以可以在線發(fā)布，這樣開(kāi)發(fā)人員就能很容易地訪問(wèn)這些文檔。以一種可以輕松瀏覽的格式來(lái)提供API文檔，這種方法使得開(kāi)發(fā)人員不必仔細(xì)地查看源代碼才能了解某個(gè)類或方法會(huì)有怎樣的行為，以及該如何使用。<br>

JSDoc是面向JavaScript的一個(gè)類似的工具（jsdoc.sourceforge.net）。JSDoc是一個(gè)開(kāi)源工具，是采用GPL（GNU Public License）協(xié)議發(fā)布的。JSDoc用Perl編寫(xiě)，這意味著Windows用戶必須安裝一個(gè)Perl運(yùn)行時(shí)環(huán)境。（而對(duì)于大多數(shù)Linux和Unix操作系統(tǒng)，Perl是其中的一個(gè)標(biāo)準(zhǔn)部分）。<br>