|
Same here Mike, the documentation ( when I'm made to do it ) takes me longer than the programming.
"Life should not be a journey to the grave with the intention of arriving safely in a pretty and well-preserved body, but rather to skid in broadside in a cloud of smoke, thoroughly used up, totally worn out, and loudly proclaiming βWow! What a Ride!" - Hunter S Thompson - RIP
|
|
|
|
|
I hear ya. I start out and try to get everything just so and as I get further into it I lose interest and just rush through, so the beginnings are half way decent but the further you read the more convoluted it becomes.
The less you need, the more you have.
Even a blind squirrel gets a nut...occasionally.
JaxCoder.com
|
|
|
|
|
This might be a situation like TDD where it's a lot less overwhelming if you do it as you go.
One thing I do in visual studio when I'm working professionally, or at least on an involved open source offering, is I mark warnings as errors in release builds and also tell it to generate docs from doc comments.
That way any publicly exposed methods that don't have doc comments on them get flagged as errors under the release builds.
It's a start.
But honestly, just try writing a technical article about your code. It doesn't have to be good - you might be the only reader of it.
But with it, you can generate an outline, and with that a table of contents.
Failing that, you can go through the header files and start your outline with the name of each, before drilling down into them. If you already divide your source code out into multiple files as a matter of course this can work pretty well in terms of getting you started.
And if you're not great at writing, write samples. Lean on that. A little bit of verbiage with a lot of example code.
I hope some of that helps.
To err is human. Fortune favors the monsters.
|
|
|
|
|
Thanks for the advic.
The less you need, the more you have.
Even a blind squirrel gets a nut...occasionally.
JaxCoder.com
|
|
|
|
|
I was kind of a writer first. I wound up being part of "Young Authors" twice, I could have seen getting an English or a degree in literature as easily as I got into coding if things had played out differently. I learned to read when I was 3, and was voracious about it for a long time. I think picking up literacy early sort of wired me for writing. Audre Lorde (activist, poet) also learned to read at 3, although she was a better writer than I am. Still my point is, I think training young is what does it, and the younger you can do it, the easier is is when you get older. I could be wrong. Maybe we're wired a certain way and that leads to early literacy and a knack for writing. Causality in matters like that can get slippery fast.
Either way, the gift really helps when it comes to documenting what I've coded. I feel blessed for it.
To err is human. Fortune favors the monsters.
|
|
|
|
|
I have attention problems, but I'm getting better.
I have become a voracious reader, I've probably read 70-80 books this year and I've got many more lined up.
My writing is getting better, at least I think so, but it's so hard to get going.
I'm finding that many folks can write but few are really good at it.
The less you need, the more you have.
Even a blind squirrel gets a nut...occasionally.
JaxCoder.com
|
|
|
|
|
I donβt understand what you are trying to say hereβ¦
π€ͺ
If you can't laugh at yourself - ask me and I will do it for you.
|
|
|
|
|
"We choose to go to the moon and do the other things, not because they're easy, but because they are hard."
|
|
|
|
|
No pain, no gain... sorry for cliche but mostly true.
Reading is like breathing for the brain and writing is somewhat similar but comes later.
Without it, life is cruel.
Most people in US prisons are functionally illiterate.
|
|
|
|
|
To be adventurous or to be prudent?
Be adventurous about what you discover and prudent about what you implement.
If you discover a better less error prone path then it could be prudent to implement it.
|
|
|
|
|
That doesn't work for me when I'm learning though, because I learn by doing, which means I'll implement something well before I realize I understand it, and that process helps me understand it further. The implementation I'm left with generally needs some retooling but that's how it goes.
To err is human. Fortune favors the monsters.
|
|
|
|
|
I learn by doing to and I have an enormous codebase of fantastical experimental ideas from which I have learned a lot but would not employ in production code. Having said that, I am retired now and can afford to be wise and circumspect. In fact I specialise in it because it is less stressful.
Back in the day though, I used to innovate wildly and put it straight out in the field because it was needed. I had a lot of confidence in what I was doing but it did mean that I had to become an expert at completely refactoring my own innovations without breaking anything - usually because I hit a design cul-de-sac tying up loose ends. Yes, you do have to roll up your sleeves, get your hands dirty and have confidence in your own brilliant ideas. I still do it but I now have the luxury of only publishing what I want to when I think it is ready.
|
|
|
|
|
I believe that when I stop growing, I stop living. Even breaks from direct learning can provide growth just as rest periods are when the muscles grow when weight training.
I can always find ways to grow, even in an environment where I'm working with what I know, but absolutely new things are a delight to learn, it's true.
|
|
|
|
|
that's not how you become a better coder
that's how you become a better human
|
|
|
|
|
In some ways I guess. I think I get a lot more mileage out of helping people, in terms of becoming a better human in the general sense.
But I guess it depends on which rubber ruler you use, and what better really involves. It's a slippery concept, for sure.
To err is human. Fortune favors the monsters.
|
|
|
|
|
Wordle 312 2/6
β¬β¬π©π©π¨
π©π©π©π©π©
|
|
|
|
|
Wordle 312 3/6*
β¬β¬β¬β¬π¨
π¨π©π©β¬β¬
π©π©π©π©π©
Happiness will never come to those who fail to appreciate what they already have. -Anon
|
|
|
|
|
Wordle 312 4/6
β¬β¬β¬β¬β¬
β¬π¨β¬β¬π©
β¬π©π©β¬π©
π©π©π©π©π©
|
|
|
|
|
Wordle 312 3/6
β¬π¨β¬β¬β¬
π¨π¨β¬β¬π¨
π©π©π©π©π©
Software rusts. Simon Stephenson, ca 1994. So does this signature. me, 2012
|
|
|
|
|
Well done - three for me:
Wordle 312 3/6
β¬β¬β¬🟨β¬
🟩🟨🟩β¬β¬
🟩🟩🟩🟩🟩
"I have no idea what I did, but I'm taking full credit for it." - ThisOldTony
"Common sense is so rare these days, it should be classified as a super power" - Random T-shirt
AntiTwitter: @DalekDave is now a follower!
|
|
|
|
|
4/6
β¬β¬β¬β¬β¬
β¬π¨β¬π¨β¬
π¨π©β¬β¬π¨
π©π©π©π©π©
Lucky I got all 5 letters plus one fixed so it was again a simple anagram
GCS/GE d--(d) s-/+ a C+++ U+++ P-- L+@ E-- W+++ N+ o+ K- w+++ O? M-- V? PS+ PE Y+ PGP t+ 5? X R+++ tv-- b+(+++) DI+++ D++ G e++ h--- r+++ y+++* Weapons extension: ma- k++ F+2 X
|
|
|
|
|
Wordle 312 6/6*
β¬β¬β¬π¨β¬
π©β¬β¬β¬β¬
π©β¬π©β¬β¬
π©β¬π©β¬π©
π©π¨π©β¬π©
π©π©π©π©π©
|
|
|
|
|
Wordle 312 3/6
π©β¬β¬β¬β¬
π©β¬π©β¬β¬
π©π©π©π©π©
None of the previous ones are playing in dark mode?!
modified 27-Apr-22 7:19am.
|
|
|
|
|
I do but I prefer using a single color system for consistency, and OG and Vivi practically set the 'default' scheme for me.
EDIT: the fact that I have thought about it and had a reasoned answer is... worrisome, to some degree. You can pull the boy out of Engineering but you can't pull the Engineer out of the man.
GCS/GE d--(d) s-/+ a C+++ U+++ P-- L+@ E-- W+++ N+ o+ K- w+++ O? M-- V? PS+ PE Y+ PGP t+ 5? X R+++ tv-- b+(+++) DI+++ D++ G e++ h--- r+++ y+++* Weapons extension: ma- k++ F+2 X
|
|
|
|
|
OK, I fixed it to help calm your OCD.
|
|
|
|