JSDoc

JSDoc ay maaaring gumawa ng mga babasahin sa isang malawak na bilang ng mga format ng text-based tulad ng HTML, XML, JSON, at iba pa.

JSDoc ay dating kilala bilang JsDoc Toolkit.

Ang dating bersyon JSDoc ginagamit ng Java upang i-parse ang source code, kunin ang mga komento at bumuo ng mga babasahin. Dahil ang branch 3.x Node.js ay ginamit sa halip.

Bukod Node.js, JSDoc maaari din sa Rhino engine Mozilla rin.

Upang gamitin JSDoc maayos, i-check ang kanyang mga babasahin para sa impormasyon tungkol sa kung paano i-format ang iyong mga komento source code upang maaari nilang nakita at ginagamit ng engine JSDoc ni.

Ano ang bagong sa paglabas:.

• Maaari na ngayong magpatakbo JSDoc sa Node.js
• Maaari na ngayong gamitin ang @ interface atimplements tag upang idokumento ang interface at ang kanilang pagpapatupad.
• inheritDoc atoverride tags Pagsasara Compiler ni ay suportado na ngayon.
• Kung ang JSDoc comment para sa isang simbolo ay kinabibilangan ng mga tagmixes, ang lahat ng mga mixins lilitaw na ngayon sa dokumentasyon ang simbolo ni.
• JSDoc ay maaari na ngayong ang impormasyon mag-log sa console na ito ay tumatakbo (halimbawa, ang pangalan ng bawat file na pina-parse JSDoc). Upang mag-log ang impormasyon na ito, patakbuhin JSDoc sa --verbose flag.
• Maaari na ngayong gumamit ng anumang file bilang ang pakete o Readme file para sa iyong mga babasahin. Gamitin ang P / - pakete / at R / -. Readme flag upang tukuyin ang mga pakete at Readme file
• typography at scheme ng kulay Ang default template ni ay makabuluhang pinabuting.

Ano ang bagong sa bersyon 3.3.2:

• Maaari na ngayong magpatakbo JSDoc sa Node.js.
• Maaari na ngayong gamitin ang @ interface atimplements tag upang idokumento ang interface at ang kanilang pagpapatupad.
• inheritDoc atoverride tags Pagsasara Compiler ni ay suportado na ngayon.
• Kung ang JSDoc comment para sa isang simbolo ay kinabibilangan ng mga tagmixes, ang lahat ng mga mixins lilitaw na ngayon sa dokumentasyon ang simbolo ni.
• JSDoc ay maaari na ngayong ang impormasyon mag-log sa console na ito ay tumatakbo (halimbawa, ang pangalan ng bawat file na pina-parse JSDoc). Upang mag-log ang impormasyon na ito, patakbuhin JSDoc sa --verbose flag.
• Maaari na ngayong gumamit ng anumang file bilang ang pakete o Readme file para sa iyong mga babasahin. Gamitin ang P / - pakete / at R / -. Readme flag upang tukuyin ang mga pakete at Readme file
• typography at scheme ng kulay Ang default template ni ay makabuluhang pinabuting.

Ano ang bagong sa bersyon 3.3.0:

• Maaari na ngayong magpatakbo JSDoc sa Node.js.
• Maaari na ngayong gamitin ang @ interface atimplements tag upang idokumento ang interface at ang kanilang pagpapatupad.
• inheritDoc atoverride tags Pagsasara Compiler ni ay suportado na ngayon.
• Kung ang JSDoc comment para sa isang simbolo ay kinabibilangan ng mga tagmixes, ang lahat ng mga mixins lilitaw na ngayon sa dokumentasyon ang simbolo ni.
• JSDoc ay maaari na ngayong ang impormasyon mag-log sa console na ito ay tumatakbo (halimbawa, ang pangalan ng bawat file na pina-parse JSDoc). Upang mag-log ang impormasyon na ito, patakbuhin JSDoc sa --verbose flag.
• Maaari na ngayong gumamit ng anumang file bilang ang pakete o Readme file para sa iyong mga babasahin. Gamitin ang P / - pakete / at R / -. Readme flag upang tukuyin ang mga pakete at Readme file
• typography at scheme ng kulay Ang default template ni ay makabuluhang pinabuting.

Ano ang bagong sa bersyon 3.2.2 / 3.3.0-beta1:

• Natugunan ng isang pagbabalik sa JSDoc 3.2.1 na maaaring pigilan ang isang function deklarasyon mula sa pagsosombra ng isang deklarasyon na may parehong pangalan sa isang panlabas na saklaw.
• Kung Ino-override ang isang klase ng bata ang isang pamamaraan sa isang klase ng magulang na walang dokumento ang mga importansiya method, babasahin ang paraan na ito ang kinopya na ngayon mula sa klase ng magulang.
• Maaari mo na ngayong gamitin ang mga inline na mga tag na HTML sa Markdown-format na teksto. Sa karagdagan, ngayon ay gumagamit ng JSDoc lamang ang markadong Markdown parser; ang markdown-js parser ay inalis na.
• Uri ng mga expression ay maaari na ngayong magsama ng isang mas malawak na hanay ng repeatable uri. Sa karagdagan, maaari mo na ngayong gamitin nullable at di-nullable modifier Pagsasara Compiler kay repeatable uri. Halimbawa, ang mga uri ng pagpapahayag ...! String (a repeatable, non-nullable string) ay parse ngayon nang tama.

Ano ang bagong sa bersyon 2.4.0:

• Fixed bug na idinagdag mutiple simbolo na may parehong pangalan sa docs.
• Idinagdag ang suporta para sa mga m pagpipilian upang sugpuin ang mga babala para sa maramihang mga docs.
• Idinagdag patch pamamagitan brownsea42 upang suportahan ang naka-quote na mga variable user sa command line.
• Mga Fixed bug na minsan ay sanhi ng mga link sa mga kaganapan na hindi tama.

Mga kinakailangan

• enable ang JavaScript sa client side
• Node.js 0.10 o mas mataas