• jbrains@sh.itjust.works
    link
    fedilink
    arrow-up
    11
    ·
    3 months ago

    Write comments that explain why the code isn’t obvious just by reading it. Why did you do things the long way? What did you need to work around? Why didn’t you do the thing that anyone reading the code would expect you to do?

    Also write comments that explain the purpose of the functions you use, in case the names of those functions don’t make it clear on their own.