opdavies/oliverdavies.uk
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add daily email for 2024-06-03

Browse source 
Writing comments first
This commit is contained in:
Oliver Davies 2024-06-07 01:02:15 +01:00
parent 0c3d74fbc5
commit 59e7809438
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
source/_daily_emails/2024-06-03.md Normal file
View file

@ -0,0 +1,20 @@
---
title: Writing comments first
date: 2024-06-03
permalink: daily/2024/06/03/writing-comments-first
tags:
- software-development
cta: d7eol
snippet: |
Why I usually start by writing my code comments before my code.
---
Something I often do before writing new code is to write out what it needs to do, either in a README file or as code comments.
It could be paragraphs of text explaining the problem I'm solving, or a short checklist of what the code needs to do.
This clarifies the situation and the approach and allows uncovering any potential questions or issues.
It takes time, but I can complete the task quicker as I've made the decisions and answered any questions upfront.
I'll either remove the comments as I write the code or, if they still add value, I'll keep them to add more context and information.