Code for People, Not for Machines - A Glimps into my Newest Book

1

Ruby on Rails

A programming paradigm used by some frameworks (made popular by Ruby on Rails back in the day) is called “Convention over configuration” and it means you should expect to have “sensible default” behavior and only care about creating specific code for a section of your logic if that expected default is not met. For example, having a class representing a database table on your code, if that class is called “Notes” then you’d expect the table to have the same name and your class to have one property for each field on the table (again, aptly named and typed). Only if for some reason that expectation isn’t met, you’ll have to jump in and write the required code to map the values or whatever you need to make the class work between both worlds (this is your internal logic and the database structure).

#Developer Tools #Web Frameworks #Frameworks (Full Stack) 117 social mentions

2

JSDoc

Notice how the tooltips generated by the same code differ when a properly formatted comment is added into the mix. This is JavaScript code and the comments are following JSDocs standards. These standards tell you how to format your comments with a structure that a machine can then parse and get useful information out of. You clearly identify things such as variable types and names, return types, descriptions, and more, and then, in our case, the IDE parses it and show an informative tooltip.

#Documentation #Documentation As A Service & Tools #Developer Tools 49 social mentions