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:
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.
-
SkillsCast
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:
Thanks to our sponsors
-
About the Speaker
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.