Show notes are at https://stevelitchfield.com/sshow/chat.html
…
continue reading
Content provided by Ross Hunter and The New Best Practices. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Ross Hunter and The New Best Practices or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Similar to The New Best Practices
Podcast by Mark Phoenix and Ben Hutchings
…
continue reading
This is the audio podcast version of Troy Hunt's weekly update video published here: https://www.troyhunt.com/tag/weekly-update/
…
continue reading
Africa-focused technology, digital and innovation ecosystem insight and commentary.
…
continue reading
A weekly podcast on deploying and managing enterprise storage and data
…
continue reading
Embedded is the show for people who love gadgets. Making them, breaking them, and everything in between. Weekly interviews with engineers, educators, and enthusiasts. Find the show, blog, and more at embedded.fm.
…
continue reading
Tech Life discovers and explains the ways technology is changing our lives, wherever we are in the world. We meet the people with bright ideas for rethinking the way we work, learn and play, and get hands-on with the products they dream up. We hold tech giants to account for their huge power to affect our lives, and ask who wins, and who loses, in the technology transformation. Tech Life is your guide to a future being made, and remade, at lightning speed in front of our eyes.
…
continue reading
Get ready for a weekly dose of all things Enterprise Software and Cloud Computing! Join us as we dive into topics including Kubernetes, DevOps, Serverless, Security and Coding. Plus, we’ll keep you entertained with plenty of off-topic banter and nonsense. Don’t worry if you miss the latest industry conference - we’ve got you covered with recaps of all the latest news from AWS, Microsoft Azure, Google Cloud Platform (GCP) and the Cloud Native Computing Foundation (CNCF).
…
continue reading
Podcast by ycombinator
…
continue reading
The science stories that will actually change your day — and maybe make you laugh. Science unscripted is a podcast, radio show & YouTube channel driven by listeners. Hello from Germany :)
…
continue reading
Player FM - Podcast App
Go offline with the Player FM app!
Go offline with the Player FM app!
))
Code Comments
Manage episode 197174641 series 1981042
Content provided by Ross Hunter and The New Best Practices. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Ross Hunter and The New Best Practices or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Outline
- Definition of comments: “Metadata in source code that describe what code fails to communicate. Some languages and frameworks opt to use the mechanism of comments as formal documentation for code, but these two concepts should be separated.“
- Strive to make code self-documenting
- Formal Documentation vs. Code Comments
- Using tests to document your code
- Considering strong types as a type of documentation
- Docstring Tests
- The value of documenting types
- Worthless comments should be avoided
- Don’t use comments to “vent” your emotions
Links
- Python doctest
- JSON API Expectations Semantic expectation helpers for JSON API testing using RSpec and Airborne.
9 episodes
Share
Manage episode 197174641 series 1981042
Content provided by Ross Hunter and The New Best Practices. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Ross Hunter and The New Best Practices or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Outline
- Definition of comments: “Metadata in source code that describe what code fails to communicate. Some languages and frameworks opt to use the mechanism of comments as formal documentation for code, but these two concepts should be separated.“
- Strive to make code self-documenting
- Formal Documentation vs. Code Comments
- Using tests to document your code
- Considering strong types as a type of documentation
- Docstring Tests
- The value of documenting types
- Worthless comments should be avoided
- Don’t use comments to “vent” your emotions
Links
- Python doctest
- JSON API Expectations Semantic expectation helpers for JSON API testing using RSpec and Airborne.
9 episodes
All episodes
×
Welcome to Player FM!
Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.
Similar to The New Best Practices
Show notes are at https://stevelitchfield.com/sshow/chat.html
…
continue reading
Podcast by Mark Phoenix and Ben Hutchings
…
continue reading
This is the audio podcast version of Troy Hunt's weekly update video published here: https://www.troyhunt.com/tag/weekly-update/
…
continue reading
Africa-focused technology, digital and innovation ecosystem insight and commentary.
…
continue reading
A weekly podcast on deploying and managing enterprise storage and data
…
continue reading
Embedded is the show for people who love gadgets. Making them, breaking them, and everything in between. Weekly interviews with engineers, educators, and enthusiasts. Find the show, blog, and more at embedded.fm.
…
continue reading
Tech Life discovers and explains the ways technology is changing our lives, wherever we are in the world. We meet the people with bright ideas for rethinking the way we work, learn and play, and get hands-on with the products they dream up. We hold tech giants to account for their huge power to affect our lives, and ask who wins, and who loses, in the technology transformation. Tech Life is your guide to a future being made, and remade, at lightning speed in front of our eyes.
…
continue reading
Get ready for a weekly dose of all things Enterprise Software and Cloud Computing! Join us as we dive into topics including Kubernetes, DevOps, Serverless, Security and Coding. Plus, we’ll keep you entertained with plenty of off-topic banter and nonsense. Don’t worry if you miss the latest industry conference - we’ve got you covered with recaps of all the latest news from AWS, Microsoft Azure, Google Cloud Platform (GCP) and the Cloud Native Computing Foundation (CNCF).
…
continue reading
Podcast by ycombinator
…
continue reading
The science stories that will actually change your day — and maybe make you laugh. Science unscripted is a podcast, radio show & YouTube channel driven by listeners. Hello from Germany :)
…
continue reading
Player FM - Podcast App
Go offline with the Player FM app!
Go offline with the Player FM app!
