3 ms·
> If you are putting "magic numbers" anywhere, COMMENT it as to what that number is, why you chose it, etc. Better yet, turn magic numbers into constant variab
by dwaltrip 5y ago
> If you are putting "magic numbers" anywhere, COMMENT it as to what that number is, why you chose it, etc.
Better yet, turn magic numbers into constant variables whose name becomes the comment. Of course, comments can also provide additional context :)
- srigi 5y agoAgree. I also add to this - name your constants by meaning, not value. Too many times I see const ONE_HOUR_IN_MS = 3600000 Instead I would like to see const RESEND_DELAY = 3600000
- wonderbore 5y agoBetter yet: const ONE_HOUR_IN_MS = 3600000 const RESEND_DELAY = ONE_HOUR_IN_MS
- mongol 5y agoI don't get why this is better. My approach: const RESEND_DELAY_MS = 3600000; // because TTL in Agora
- schobi 5y agoI would even go for const RESEND_DELAY_MS = 3600*1000; // because TTL in Agora Easier to check for the right number of zeros
- mongol 5y agoYes full agree
- sigg3 5y agoI've used stuff like this to do: const ONE_HOUR = 3600000; const RESEND_DELAY_MS = 2.5 * ONE_HOUR; // because TTL in Agora IMO it makes it easier for successor to fiddle with.
- tisc 5y agoI like to combine those: const RESEND_DELAY_MS = ONE_HOUR_IN_MS; Having the unit in the name saved me more than once and having non-contextual constants for sizes increases readability imo.
- kissgyorgy 5y agoI do this instead: const RESEND_DELAY_MS = 1 * 60 * 60 * 1000; // one hour Essentially the same, but the lack of extra variable spares one jump. Also you can change it without introducing a new variable (no dependency).