Programming

Documentation

  • Docusaurus - easily craete documentation websites

Resources

  • Long Names Are Long - how to name variables

    • Omit words that are obvious given a variable’s or parameter’s type: weekDaysList vs. weekDays

    • Omit words that don’t disambiguate the name: finalBattleMostDangerousBossMonster vs. boss

    • Omit words that are known from the surrounding context: struct Sale { SaleDiscount float64 } vs struct Sake { Discount float64 }

    • Omit words that don’t mean much of anything: data, object, entity, etc.

Code sharing