Show notes are at https://stevelitchfield.com/sshow/chat.html
…
continue reading
Контент предоставлен Ross Hunter and The New Best Practices. Весь контент подкастов, включая эпизоды, графику и описания подкастов, загружается и предоставляется непосредственно компанией Ross Hunter and The New Best Practices или ее партнером по платформе подкастов. Если вы считаете, что кто-то использует вашу работу, защищенную авторским правом, без вашего разрешения, вы можете выполнить процедуру, описанную здесь https://ru.player.fm/legal.
Player FM - приложение для подкастов
Работайте офлайн с приложением Player FM !
Работайте офлайн с приложением Player FM !
Code Comments
MP3•Главная эпизода
Manage episode 197174641 series 1981042
Контент предоставлен Ross Hunter and The New Best Practices. Весь контент подкастов, включая эпизоды, графику и описания подкастов, загружается и предоставляется непосредственно компанией Ross Hunter and The New Best Practices или ее партнером по платформе подкастов. Если вы считаете, что кто-то использует вашу работу, защищенную авторским правом, без вашего разрешения, вы можете выполнить процедуру, описанную здесь https://ru.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 эпизодов
MP3•Главная эпизода
Manage episode 197174641 series 1981042
Контент предоставлен Ross Hunter and The New Best Practices. Весь контент подкастов, включая эпизоды, графику и описания подкастов, загружается и предоставляется непосредственно компанией Ross Hunter and The New Best Practices или ее партнером по платформе подкастов. Если вы считаете, что кто-то использует вашу работу, защищенную авторским правом, без вашего разрешения, вы можете выполнить процедуру, описанную здесь https://ru.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 эпизодов
Все серии
×Добро пожаловать в Player FM!
Player FM сканирует Интернет в поисках высококачественных подкастов, чтобы вы могли наслаждаться ими прямо сейчас. Это лучшее приложение для подкастов, которое работает на Android, iPhone и веб-странице. Зарегистрируйтесь, чтобы синхронизировать подписки на разных устройствах.