Documenting with JSDuck

•

0 gostou•1,732 visualizações

Documentation is an important part of any project, especially when there is an API to be exposed to other developers. JSDuck is an open source ExtJS 4 project developed at Sencha to help Javascript developers generate beautiful documentation viewable in a web browser. Based loosely on JavaDoc, JSDuck parses documentation embedded in the source files of your project enabling you to keep your docs close to your code. In this session we will cover the many features of JSDuck and by the end you will know how to create API documentation, guides, videos and examples for your own project or application.

Tecnologia

Documenting with jsduck Nick Poulden, Sencha

@nick_p

Tuesday 25th October, 2011

Zombies by @jayrobinson

Wednesday, November 2, 2011

Why Document?

Wednesday, November 2, 2011

Today
JSDuck App (10 mins)
Using JSDuck (30 mins)
Questions (5 mins)

Wednesday, November 2, 2011

JSDuck Live Demo

Wednesday, November 2, 2011

JSDuck Tutorial

Wednesday, November 2, 2011

Use JSDuck!
sudo gem install jsduck

github.com/senchalabs/jsduck

Wednesday, November 2, 2011

Mais conteúdo relacionado

Destaque

Ext JS 4: Advanced Expert TechniquesSencha

Community Code: MacadamianSencha

Application Security for RIAsSencha

Java Server-side BreakoutSencha

Introducing Designer 2Sencha

Community Code: XeroSencha

Sencha and Spring (Spring 2GX 2013) Sencha

Migrating from Ext GWT 2.x to 3.0Sencha

Introducing Ext GWT 3.0Sencha

WebGL FundamentalsSencha

Hacking Webkit & Its JavaScript EnginesSencha

Community Code: Pega MobileSencha

SenchaCon 2016: Building Enterprise Ext JS Apps with Mavenized Sencha Cmd - F...Sencha

SenchaCon 2016: Building a Faceted Catalog of Video Game Assets Using Ext JS ...Sencha

SenchaCon 2016: Oracle Forms Modernisation - Owen PaganSencha

SenchaCon 2016: Accessibility, Teamwork & Ext JS: A Customer Success Story - ...Sencha

SenchaCon 2016: Creating a Flexible and Usable Industry Specific Solution - D...Sencha

SenchaCon 2016: Handling Undo-Redo in Sencha Applications - Nickolay PlatonovSencha

SenchaCon 2016: Developing and Delivering Quality Code, Frequently - Neil ManvarSencha

Destaque (19)

Ext JS 4: Advanced Expert Techniques

Community Code: Macadamian

Application Security for RIAs

Java Server-side Breakout

Introducing Designer 2

Community Code: Xero

Sencha and Spring (Spring 2GX 2013)

Migrating from Ext GWT 2.x to 3.0

Introducing Ext GWT 3.0

WebGL Fundamentals

Hacking Webkit & Its JavaScript Engines

Community Code: Pega Mobile

SenchaCon 2016: Building Enterprise Ext JS Apps with Mavenized Sencha Cmd - F...

SenchaCon 2016: Building a Faceted Catalog of Video Game Assets Using Ext JS ...

SenchaCon 2016: Oracle Forms Modernisation - Owen Pagan

SenchaCon 2016: Accessibility, Teamwork & Ext JS: A Customer Success Story - ...

SenchaCon 2016: Creating a Flexible and Usable Industry Specific Solution - D...

SenchaCon 2016: Handling Undo-Redo in Sencha Applications - Nickolay Platonov

SenchaCon 2016: Developing and Delivering Quality Code, Frequently - Neil Manvar

Mais de Sencha

Breathe New Life into Your Existing JavaScript Applications with Web ComponentsSencha

Ext JS 6.6 HighlightsSencha

Sencha Roadshow 2017: BufferedStore Internals featuring eyeworkers interactiv...Sencha

Sencha Roadshow 2017: Build Progressive Web Apps with Ext JS and Cmd Sencha

Sencha Roadshow 2017: Best Practices for Implementing Continuous Web App TestingSencha

Sencha Roadshow 2017: What's New in Sencha TestSencha

Sencha Roadshow 2017: Sencha Upgrades - The Good. The Bad. The Ugly - Eva Luc...Sencha

Sencha Roadshow 2017: Modernizing the Ext JS Class System and ToolingSencha

Sencha Roadshow 2017: Sencha Best Practices: Coworkee App Sencha

Sencha Roadshow 2017: Mobile First or Desktop FirstSencha

Sencha Roadshow 2017: Innovations in Ext JS 6.5 and BeyondSencha

Leveraging React and GraphQL to Create a Performant, Scalable Data GridSencha

Learn Key Insights from The State of Web Application Testing Research ReportSencha

Introducing ExtReact: Adding Powerful Sencha Components to React AppsSencha

SenchaCon 2016: Keynote Presentation - Art Landro, Gautam Agrawal, Mark BrocatoSencha

SenchaCon 2016: Add Magic to Your Ext JS Apps with D3 Visualizations - Vitaly...Sencha

SenchaCon 2016: LinkRest - Modern RESTful API Framework for Ext JS Apps - Rou...Sencha

SenchaCon 2016: Expect the Unexpected - Dealing with Errors in Web AppsSencha

Ext JS Architecture Best Practices - Mitchell SimeonsSencha

SenchaCon 2016: Mobile First? Desktop First? Or Should you Think Universal Ap...Sencha

Mais de Sencha (20)

Breathe New Life into Your Existing JavaScript Applications with Web Components

Ext JS 6.6 Highlights

Sencha Roadshow 2017: BufferedStore Internals featuring eyeworkers interactiv...

Sencha Roadshow 2017: Build Progressive Web Apps with Ext JS and Cmd

Sencha Roadshow 2017: Best Practices for Implementing Continuous Web App Testing

Sencha Roadshow 2017: What's New in Sencha Test

Sencha Roadshow 2017: Sencha Upgrades - The Good. The Bad. The Ugly - Eva Luc...

Sencha Roadshow 2017: Modernizing the Ext JS Class System and Tooling

Sencha Roadshow 2017: Sencha Best Practices: Coworkee App

Sencha Roadshow 2017: Mobile First or Desktop First

Sencha Roadshow 2017: Innovations in Ext JS 6.5 and Beyond

Leveraging React and GraphQL to Create a Performant, Scalable Data Grid

Learn Key Insights from The State of Web Application Testing Research Report

Introducing ExtReact: Adding Powerful Sencha Components to React Apps

SenchaCon 2016: Keynote Presentation - Art Landro, Gautam Agrawal, Mark Brocato

SenchaCon 2016: Add Magic to Your Ext JS Apps with D3 Visualizations - Vitaly...

SenchaCon 2016: LinkRest - Modern RESTful API Framework for Ext JS Apps - Rou...

SenchaCon 2016: Expect the Unexpected - Dealing with Errors in Web Apps

Ext JS Architecture Best Practices - Mitchell Simeons

SenchaCon 2016: Mobile First? Desktop First? Or Should you Think Universal Ap...

Último

"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays

What is DBT - The Ultimate Data Build Tool.pdfMounikaPolabathina

DevEX - reference for building teams, processes, and platformsSergiu Bodiu

Generative AI for Technical Writer or Information DevelopersRaghuram Pandurangan

The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptxLoriGlavin3

Dev Dives: Streamline document processing with UiPath Studio WebUiPathCommunity

Ensuring Technical Readiness For Copilot in Microsoft 3652toLead Limited

Sample pptx for embedding into website for demoHarshalMandlekar2

Anypoint Exchange: It’s Not Just a Repo!Manik S Magar

The Ultimate Guide to Choosing WordPress Pros and ConsPixlogix Infotech

A Journey Into the Emotions of Software DevelopersNicole Novielli

Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada

Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptxLoriGlavin3

Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada

DSPy a system for AI to Write Prompts and Do Fine TuningLars Bell

"ML in Production",Oleksandr BaganFwdays

The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptxLoriGlavin3

Nell’iperspazio con Rocket: il Framework Web di Rust!Commit University

Gen AI in Business - Global Trends Report 2024.pdfAddepto

WordPress Websites for Engineers: Elevate Your Brandgvaughan