Automating documentation on JavaScript projects
Please log in to watch this conference skillscast.
Documenting code is an important task that few teams get right. Docs get easily outdated, everybody hates writing them and sometimes developers don’t even use them at all.
In this talk, you will learn about an approach to documentation writing based on adding comments directly to the source code. Marcos will show you its benefits applied to three different types of codebases.
You will also learn how to generate documentation from those same comments in two different flavors as well as when each of them work best.
YOU MAY ALSO LIKE:
- Performance Budgets: The What, Why And How (SkillsCast recorded in July 2018)
- Fast Track to DevOps Fundamentals (in London on 2nd - 3rd September 2019)
- React & Redux Workshop with Damjan Vujnovic (in London on 16th - 18th September 2019)
- ProgNET London 2019 (in London on 11th - 13th September 2019)
- Haskell eXchange 2019 (in London on 10th - 11th October 2019)
- Dynamic forms with NgRx with Juan Stoppa (in London on 25th July 2019)
- A Gentler Introduction to Vertex Shaders (in London on 30th July 2019)
- Keynote: The Web: The Good Parts (SkillsCast recorded in July 2019)
- Done in 0.0166666666 Seconds (SkillsCast recorded in July 2019)
Thanks to our sponsors
Automating documentation on JavaScript projects
Marcos Iglesias Valle
Marcos Iglesias is a Senior Software Engineer who builds compelling user interfaces at Eventbrite. Marcos is passionate about improving web performance, setting performance budgets and tracking them because "web performance matters!" On top of all that, he enjoys writing about software, giving talks and maintaining Britecharts, the open source charting library.
Please log in to watch this conference skillscast.
Documenting code is an important task that few teams get right. Docs get easily outdated, everybody hates writing them and sometimes developers don’t even use them at all.
In this talk, you will learn about an approach to documentation writing based on adding comments directly to the source code. Marcos will show you its benefits applied to three different types of codebases.
You will also learn how to generate documentation from those same comments in two different flavors as well as when each of them work best.
YOU MAY ALSO LIKE:
- Performance Budgets: The What, Why And How (SkillsCast recorded in July 2018)
- Fast Track to DevOps Fundamentals (in London on 2nd - 3rd September 2019)
- React & Redux Workshop with Damjan Vujnovic (in London on 16th - 18th September 2019)
- ProgNET London 2019 (in London on 11th - 13th September 2019)
- Haskell eXchange 2019 (in London on 10th - 11th October 2019)
- Dynamic forms with NgRx with Juan Stoppa (in London on 25th July 2019)
- A Gentler Introduction to Vertex Shaders (in London on 30th July 2019)
- Keynote: The Web: The Good Parts (SkillsCast recorded in July 2019)
- Done in 0.0166666666 Seconds (SkillsCast recorded in July 2019)
Thanks to our sponsors
Automating documentation on JavaScript projects
Marcos Iglesias Valle
Marcos Iglesias is a Senior Software Engineer who builds compelling user interfaces at Eventbrite. Marcos is passionate about improving web performance, setting performance budgets and tracking them because "web performance matters!" On top of all that, he enjoys writing about software, giving talks and maintaining Britecharts, the open source charting library.