Show notes are at https://stevelitchfield.com/sshow/chat.html
…
continue reading
Contenuto fornito da Ross Hunter and The New Best Practices. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da Ross Hunter and The New Best Practices o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.player.fm/legal.
Player FM - App Podcast
Vai offline con l'app Player FM !
Vai offline con l'app Player FM !
Code Comments
Manage episode 197174641 series 1981042
Contenuto fornito da Ross Hunter and The New Best Practices. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da Ross Hunter and The New Best Practices o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.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 episodi
Manage episode 197174641 series 1981042
Contenuto fornito da Ross Hunter and The New Best Practices. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da Ross Hunter and The New Best Practices o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.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 episodi
Tutti gli episodi
×Benvenuto su Player FM!
Player FM ricerca sul web podcast di alta qualità che tu possa goderti adesso. È la migliore app di podcast e funziona su Android, iPhone e web. Registrati per sincronizzare le iscrizioni su tutti i tuoi dispositivi.