2020-03-06: Programming by commenting the code
My today's entry is about my work. As I've written before I'm a programmer. Some of my working days are more productive than the others, but in any case, I write a lot of code.
Today there was an extraordinary day for me. I wrote a huge amount of lines, the vast majority of them was just comments. It was about twenty lines of real programming code and several hundred lines of text where I tried to explain what this code is intended to do.
The task I was solving today was not very challenging by itself. Rather simple, I would say. But it was connected with asynchronous message incoming and possible loss of the arbitrary amount of them. Those obstacles made the simple task to be the very hard one.
I had to comment literally any simple line of code to explain why it was necessary, what it meant, why this line written this way, and why someone can't do it simpler.
The one moment make me be worried. I'm afraid in a month or two I can't understand what all those comments I've written are about. It happens often because at the moment you're writing them you are deep in the topic but when time passes you can't even remember what the problem was.
I can only hope I was comprehensible enough to make the text having a sense for me and my colleagues afterwards.
Search from various English teachers...
Corrections · 1
0
2020-03-06: Programming by commenting the code
My today's entry today is about my work. As I've written before, I'm a programmer. Some of my working days are more productive than the others, but in any case, I write a lot of code.
Today there was an extraordinary day for me. I wrote a huge amount number of lines, the vast majority of them was were just comments. It was about twenty lines of real programming code, and several hundred lines of text where I tried to explain what this code is intended to do.
The task I was solving today was not very challenging by itself. Rather simple, I would say. But it was connected with asynchronous message incoming and possible loss of the arbitrary amount of them. Those obstacles made the a simple task to be the become a very hard one.
I had to comment on literally any simple line of code to explain why it was necessary, what it meant, why this line was written this way, and why someone can't do it simpler.
The one moment thing that makes me be worried, I'm afraid in a month or two I can't won’t understand what all those comments that I've written are about. It happens often, because at the moment you're writing them you are deep in the topic, but when time passes you can't even remember what the problem was.
I can only hope I was comprehensive enough to have make the text having a make sense for to me and my colleagues and I afterwards.
If you like my corrections please look at my teaching profile and book me for a trial lesson. I can help you with your reading, writing and speaking.
Want to progress faster?
Join this learning community and try out free exercises!
Don’t miss out on the opportunity to learn a language from the comfort of your own home. Browse our selection of experienced language tutors and enroll in your first lesson now!
Start Learning Today
