3 ms·
Writing self documenting code alongside comments makes things so easy on people who have to understand your code later on. I have gotten quite a few comments f
by metamet 5y ago
Writing self documenting code alongside comments makes things so easy on people who have to understand your code later on.
I have gotten quite a few comments from former co-workers who have taken over some of the projects I was lead on about how easy it was to read. That brings me a lot of joy, knowing that I made their lives easier and that the output of the trade I invest so much time and energy into is appreciated by my peers.
- bckr 5y agoGreat work creating value for your coworkers. That said, I think `self-documenting code` is the bare minimum in 2022. At my current role, I'm pushing the org to become "documentation first"--but this goes way outside the scope of writing code. It's about writing all 4 types of documentation[] as a daily practice. This way, when you create something or learn something, that gets documented for the next person. It's not just about what variables and functions are for. It's about what the business is doing and how that relates to our work, what our poor backend-cum-devops folks are having to do day in and day out, and about helping everyone accomplish their tasks without needing to go around getting help from 3 different people over 5 days because the system is completely opaque. [] https://documentation.divio.com/ https://documentation.divio.com/
- deleted 5y ago[deleted]