))
Code Documentation is Useless
Manage episode 387016544 series 3491279
Inhalt bereitgestellt von Working as Designed Podcast. Alle Podcast-Inhalte, einschließlich Episoden, Grafiken und Podcast-Beschreibungen, werden direkt von Working as Designed Podcast oder seinem Podcast-Plattformpartner hochgeladen und bereitgestellt. Wenn Sie glauben, dass jemand Ihr urheberrechtlich geschütztes Werk ohne Ihre Erlaubnis nutzt, können Sie dem hier beschriebenen Verfahren folgen https://de.player.fm/legal.
It's easy to write what the code is doing, but does that really help? Let's talk about the WHY documentation can be useful and HOW to avoid the pitfalls.
What kind of documentation has been helpful to you?
#podcast #software #coding #webdevelopment #development #career #advice #documentation #api #restapi #sandcastles
0:00 - Intro
0:18 - Cognitive Load
1:20 - What's a bad comment
2:14 - What make's a good comment
3:40 - Documenting Rest API
8:13 - What's better? No Documentation or Heavy Documentation
8:50 - Outro
39 Episoden
Teilen
