Communication Mechanics: A Podcast for Engineers

Code Commenting


Listen Later

In this episode, host Dr. Jill Fennell sits down with Dr. David Torello, Director of the Clark Scholars Program and the College of Engineering's Dean's Scholars Program in the Woodruff School of Mechanical Engineering at Georgia Tech. The two discuss code commenting, an oft overlooked communication genre in Engineering, and consider best practices and use cases for creating effective code comments. 

Show Notes and Timestamps:

  • 00:54 - Introducing guest
  • 02:02 - Code Commenting as Communication
  • 03:14 - Purpose of Code Commenting
  • 05:44 - Mapping out Communication for Code Commenting
  • 09:17 - Genre Expectations for Code Commenting
  • 15:33 - Audience needs and Usability of Code Commenting
  • 23:02 - Code Commenting Ethos and Impact of Code Comments
  • 24:53 - Trustworthiness of Code Comments
  • 30:29 - Quality of Code Comments
  • 34:15 - Student Perspectives on Code Commenting
  • 37:56 - What David wants to see from Code Comments
  • 42:04 - Advice for students wanting to keep their skills fresh
  • 46:14 - General advice for code commenting and understanding communication

A transcript of this episode is available here.

Episode edited by Lee Hibbard.

...more
View all episodesView all episodes
Download on the App Store

Communication Mechanics: A Podcast for EngineersBy Communication Mechanics