Comment on page
Programming
- Omit words that are obvious given a variable’s or parameter’s type:
weekDaysListvs.weekDays - Omit words that don’t disambiguate the name:
finalBattleMostDangerousBossMonstervs.boss - Omit words that are known from the surrounding context:
struct Sale { SaleDiscount float64 }vsstruct Sake { Discount float64 } - Omit words that don’t mean much of anything:
data,object,entity, etc.
- different kinds of comments, when to use them and when to avoid them, mostly stuff you will learn yourself by working but with some additional insight nevertheless
- Ray tracing, Key-Value store, Web browser, Stock trading bot
Last modified 5mo ago