2024-06-07 00:02:15 +00:00
|
|
|
---
|
|
|
|
|
title: Writing comments first
|
|
|
|
|
date: 2024-06-03
|
|
|
|
|
permalink: daily/2024/06/03/writing-comments-first
|
|
|
|
|
tags:
|
2024-09-08 22:09:54 +00:00
|
|
|
- software-development
|
2024-06-07 00:02:15 +00:00
|
|
|
cta: d7eol
|
|
|
|
|
snippet: |
|
2024-09-08 22:09:54 +00:00
|
|
|
Why I usually start by writing my code comments before my code.
|
2024-06-07 00:02:15 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
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.
|
