Skip to content

Instantly share code, notes, and snippets.

@kavyasukumar

kavyasukumar/CodeCommentExample.js

Last active December 6, 2016 16:02
Show Gist options
  • Save kavyasukumar/aab89c03c62c67cbbdd7b65ac8e95947 to your computer and use it in GitHub Desktop.
Save kavyasukumar/aab89c03c62c67cbbdd7b65ac8e95947 to your computer and use it in GitHub Desktop.
Download ZIP
Code commenting example
Raw
CodeCommentExample.js
// Bad comment
// Dividing time by 24.623 and converting to integer
var days = parseInt(time / 24.623);
// Better code and comment
const HOURS_IN_MARS_DAY = 24.623;
// Calculate the number of full days spent on mars
var daysOnMars = parseInt(timeSpentOnMars / HOURS_IN_MARS_DAY);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment